This README file provides instructions on how to run the project using Docker Compose. Make sure to follow the prerequisites and create the required .env file before running the project.
Before running the project, ensure you have the following prerequisites:
- Docker installed on your machine.
- Docker Compose installed (usually comes with Docker).
The project requires an environment file named docker.env. Create this file in the root of your project and populate it with the following template:
MONGODB_USER=root
MONGODB_PASSWORD=123456
MONGODB_DATABASE=esclois_db
MONGODB_LOCAL_PORT=27017
MONGODB_DOCKER_PORT=27017
NODE_ENV=production
NODE_LOCAL_PORT=6868
NODE_DOCKER_PORT=8080
REDIS_HOST=redis
REDIS_LOCAL_PORT=6379
REDIS_DOCKER_PORT=6379
REDIS_PASSWORD=123456
NODE_JWKS_URI=http://localhost:6868/.well-known/jwks.json
NODE_JWKS_AUDIENCE=esclois
NODE_JWKS_ISSUER=http://localhost:6868
NODE_JWKS_ALGORITHMS=RS256You can modify the values in this file according to your project requirements.
To run the project, use the following command in your terminal:
docker-compose --env-file docker.env up --build -d--env-file docker.env : Specifies the environment file to use for the Docker Compose configuration.
up : Starts the defined services.
--build : Builds images before starting containers.
-d : Runs containers in detached mode, allowing them to run in the background. \
Once the command is executed, the services defined in your docker-compose.yml file will be up and running. You can access your application using the appropriate ports and endpoints.
After running the project with Docker Compose, you can explore the available API endpoints using Swagger UI. Access it at http://localhost:6868 for this example to interact with and test the API.
For more information and detailed documentation, refer to the openAPI Specifications.