- Prerequisites
- Setting Up the Project
- Running the Containers
- Usage
- Destroying the Containers
- Other Docs
- References
Before you begin, ensure you have the following installed & running properly on your server:
- Docker Desktop
- WSL (Windows Subsystem for Linux) if the server OS is Windows
The docker-compose.yml
file requires proper environment variables set before execution.
Following the .env.example
file, create another file .env
in the same directory, and set proper values. DO NOT expose them!
Create an external network to share between different compose files: -
docker network create ridesharing-shared-net
Open Terminal from project /docker directory and run the following command to run all containers in detached mode:
docker compose -f docker-compose.postgres.yml -f docker-compose.rabbitmq.yml -f docker-compose.redis.yml -f docker-compose.dev.yml -f docker-compose.nginx.yml up -d
-
Access RideSharing Customer API through
http://localhost:5000/customer-api/
.GET http://localhost:5000/customer-api
returnsRideSharing.CustomerAPI is running
message. -
Access RideSharing Authentication API through
http://localhost:5000/auth-api/
.GET http://localhost:5000/auth-api/
returnsRideSharing.AuthenticationAPI is running
message.
- Access Local MailHog Server through
http://localhost:8025
(only for dev env).
Run the following command to destroy all containers:
docker compose
-f docker-compose.postgres.yml
-f docker-compose.rabbitmq.yml
-f docker-compose.redis.yml
-f docker-compose.dev.yml
-f docker-compose.nginx.yml down
Head to other deployment readme files: -
To learn more about each of these topics, head to the following documentations:-