henriqueleite42/water-jug-challenge-nestjs

Water Jug Challenge

What is the challenge?

The challenge has a full description located in this project, click here to access it.

What do you need to run the project?

• Install node
• Install yarn
• Install Docker
• If you are using Linux, follow the instructions at docker post-installation steps
• Install Docker Compose

How to run the project?

• Run yarn to install the dependencies
• Execute docker-compose up

Routes Documentation

After executing the project locally, you can access http://localhost:3000/swagger to see an OpenAPI documentation.

Production

Every push on the master branch automatically deploys a new production version on the release branch. You can change the criteria updating the .github/workflows/deploy.yml file.