More information about the project here
To be able to run this application you need to have the followings installed:
To interact with the application, it is recommended to install the following programs, or any equivalent ones:
- Postman, or any other tool to programmatically test API endpoints.
- DBeaver, or any other tool to interact and visualize the content of a SQL database.
To launch the application, follow the instructions below:
- Create a
.env
file in the root of the project folder as the example provided. You can simplycp .env.example .env
. - Use the
Makefile
instructions to run, stop and clear the docker containers.
To properly use the provided Docker images, refer to the
docker-compose
provided.
Be sure to have a local .env
file with all the
.env.exampl
.
To check which ports are expected to be exposed in each image, check the
fields expose
or ports
.