Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wendelladriel/komeet
API template using Go and Gin
https://github.com/wendelladriel/komeet
api gin gin-framework gin-gonic go golang template
Last synced: about 2 months ago
JSON representation
API template using Go and Gin
- Host: GitHub
- URL: https://github.com/wendelladriel/komeet
- Owner: WendellAdriel
- License: mit
- Created: 2024-02-20T18:10:22.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-02-26T10:21:04.000Z (10 months ago)
- Last Synced: 2024-05-02T02:36:48.209Z (8 months ago)
- Topics: api, gin, gin-framework, gin-gonic, go, golang, template
- Language: Go
- Homepage:
- Size: 98.6 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Komeet ☄️
API Template built with Go and Gin
**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.
## Features
- 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
## Using the Template
There are two ways of using this template:
### GitHub Template
Click the `Use this template` button in the GitHub repository page.
### Git Clone
```bash
git clone [email protected]:WendellAdriel/komeet.git my-app && cd my-app && rm -rf .git
```
## Configuration
```bash
make configure
```
This will copy the configuration files from the sample ones.
Make sure to update the configuration files with the needed values.
## Building the application
```bash
make build
```
## Running the application
```bash
make run
```
## Creating Users
**Komeet** ships with a `create-user` command for creating users to the application (great for dev envs):
```bash
make create-user NAME="John Doe" [email protected] PASSWORD=secret
```
## Setting a CI/CD Pipeline
For 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.
## Credits
- [Wendell Adriel](https://github.com/WendellAdriel)
- [All Contributors](../../contributors)
## Contributing
Check the **[Contributing Guide](CONTRIBUTING.md)**.