# README
Golang API Application
This repository houses a Golang-based API application designed for managing organizations. The application includes features such as token management, CRUD operations for organizations, user invitations, and integration with MongoDB using Docker.
Project Structure
The project structure is designed to assist you in getting started quickly. You can modify it as needed for your specific requirements.
-
cmd/: Contains the main application file.
- main.go: The entry point of the application.
-
pkg/: Core logic of the application divided into different packages.
- api/: API handling components.
- handlers/: API route handlers.
- middleware/: Middleware functions.
- routes/: Route definitions.
- controllers/: Business logic for each route.
- database/: Database-related code.
- mongodb/
- models/: Data models.
- repository/: Database operations.
- mongodb/
- utils/: Utility functions.
- app.go: Application initialization and setup.
- api/: API handling components.
-
docker/: Docker-related files.
- Dockerfile: Instructions for building the application image.
-
docker-compose.yaml: Configuration for Docker Compose.
-
config/: Configuration files for the application.
- app-config.yaml: General application settings.
- database-config.yaml: Database connection details.
-
tests/: Directory for tests.
- e2e/: End-to-End tests.
- unit/: Unit tests.
-
.gitignore: Specifies files and directories to be ignored by Git.
Getting Started
To begin working with the application, follow the instructions in the project documentation. Feel free to adjust the project structure as needed based on your preferences and evolving project requirements.