# README
${PROJECT_NAME}
What is ${PROJECT_NAME} ? :bulb:
Here is description
Prerequisite :wrench:
Feature(s) :blue_book: (incoming)
- Feature 1
- Feature 2
- Feature 3
Conventions :orange_book:
Run project :tractor:
$ docker-compose up --build
Swagger doc
To generate swagger doc
$ swag init -g ./cmd/api/main.go -o ./docs
Go in http://localhost:8080/swagger/index.html
Pipeline :book:
- Lint test
- Unit tests
Libraries :books:
- Link 1
- Link 2
- Link 3
Contributor(s) :sparkles:
Wyllis Monteiro āļø |
License š
[MIT](Put link)