Skip to content

wstiehler/tempocerto-backend

Repository files navigation

coverage report

goapp gopher

tempocerto-backend

This project aims to create a microservices ecosystem for managing schedules, accommodating various companies.

Execution Guide

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

Steps for Execution

  1. Clone this repository to your local machine.

  2. In the terminal, navigate to the project root directory.

  3. 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:

  1. Open the Postman.

  2. Import the provided request collection file (postman_collection.json).

  3. Link to insominia documentation and step by step to run

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

Directory structure

.
|____docs
| |____docs
|____cmd
| |____executor
| | |____main.go
|____scripts
|____tests
| |____e2e
|____internal
| |____environment
| |____infrastructure
| | |____database
| | |____logger
| |____api
| | |____middlewares
| | |____routes
| |____domain
| | |____domain_app
|____docs

Screenshot

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published