Komeet is a simple, but powerful API template to start your APIs with Go. It uses Gin and Cobra as the base dependencies for creating a lightweight and fast API. It comes with a lot of things out-of-the-box, so you can focus on your API instead of worrying on how to build the base architecture for it.
- Login endpoint using JWT
- Logout endpoint to invalidate token
- Logged User Profile endpoint
- Auth Middleware
- Clean Architecture
- API versioning
- Mapping Requests to DTOs
- Create User command to help on development
- Configuration and Secrets using JSON format
- File logging with file rotation (Zerolog + Lumberjack)
- Models using GORM with DB migration configured
- Standard API responses
- Fallback route and error recovery configured
There are two ways of using this template:
Click the Use this template button in the GitHub repository page.
git clone git@github.com:WendellAdriel/komeet.git my-app && cd my-app && rm -rf .gitmake configureThis will copy the configuration files from the sample ones. Make sure to update the configuration files with the needed values.
make buildmake runKomeet ships with a create-user command for creating users to the application (great for dev envs):
make create-user NAME="John Doe" EMAIL=johndoe@example.com PASSWORD=secretFor non-local envs, you'll need only the content from the dist folder to be added to your server/container.
These are the steps for setting a CI/CD pipeline for Komeet applications:
1 - Run the make build command to generate the dist folder.
2 - Place the contents of the dist folder in your server/container.
3 - Add the config.json and secrets.json files to the same folder from point 2.
4 - Run the ./komeet serve command.
Check the Contributing Guide.