This project aims to create a microservices ecosystem for managing schedules, accommodating various companies.
To run this code, you need to have Makefile and Docker installed on your system. You must have ports free to run the APIs
- 3001 (documentation),
- 8080(tempocerto-api)
Documentation and Function Requeriments
The documentation has been generated using C4Builder tools. To access the documentation, simply execute the following command:
make view-doc
-
Clone this repository to your local machine.
-
In the terminal, navigate to the project root directory.
-
Run the following command to launch the application:
make dev-start-with-db
After executing the above command, the documentation will be accessible at http://localhost:3001.
To use the application methods, follow the instructions below:
-
Open the Postman.
-
Import the provided request collection file (postman_collection.json).
Local Tests
inside the application folder, run the command (Is necessary that local docker run):
- Unit test
make test-unit-verbose
- E2E tests
make test-e2e-local
.
|____docs
| |____docs
|____cmd
| |____executor
| | |____main.go
|____scripts
|____tests
| |____e2e
|____internal
| |____environment
| |____infrastructure
| | |____database
| | |____logger
| |____api
| | |____middlewares
| | |____routes
| |____domain
| | |____domain_app
|____docs