README
¶
MRT Waste Water API
Local development setup
Dependencies:
- Go 1.21
- MongoDB 10.6 or latest
- Swaggo/Swagg (for make api doc)
Create .env file from .env.example and fill your DB_DSN in there.
Install Go dependencies with go mod download.
Useful make commands:
make devmake api-docsmake unit-testmake coverage
Running locally
Run make api-docs; make dev
Access the API
Directories
¶
| Path | Synopsis |
|---|---|
|
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag
|
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag |
|
internal
|
|
Click to show internal directories.
Click to hide internal directories.