A Node, Typescript and express API to find CEP for magalu test.

• Clean code
• Use best practices of SOLID
• Make test always
• Considerations

# Install yarn, project dependencies and build.
$ make setup
# Run the project.
$ make prod

obs: To deploy in production using a container orchestrator like kubernets needs a other docker file with a new configuration.

# Build a docker container image.
$ make build-dev-docker-image
# Run container
$ make up

# Install yarn and project dependencies
$ make setup-test
# Run test
$ make test

Opened endpoints require no Authentication.

• Token : POST /token

• Health: GET /health

• Info: GET /info

• Metrics: /metrics

Closed endpoints require a valid Token to be included in the header of the request. A Token can be acquired from the Login view above.

• CEP : GET /cep/:cep