This project embodies a robust backend architecture adhering to Clean Architecture principles, ensuring modularity, testability, and maintainability.
Our API is live on an EC2 instance. Access the Swagger documentation here.
Interact effortlessly with our API using Postman. Refer to the Postman Documentation and Request Collection.
Here's how to get started with the API:
-
Environment Setup: Copy
.env.example
and create.env
, adjusting variables as necessary. -
Initialize Docker: Run the command
docker-compose up
. -
Swagger Documentation: Generate Swagger documentation:
make swagger
-
Database Setup: Utilize Docker to create the required database. Apply migrations with after creating docker:
make migrate-up
-
Testing: Run comprehensive tests with:
make test
-
Local Deployment: Launch the API locally (without Docker) using, in this scenario user needs to create db manually:
make run
-
Logging and Metrics: Access Prometheus metrics via
/metrics
and view logs on/logs
.
-
Backend Architecture: Our API is architected following Clean Architecture principles, emphasizing separation of concerns and testability.
-
GoDoc Support: While GoDoc support is integrated, it requires initialization for enhanced documentation readability. Can start godoc with
godoc -http=localhost:8080