This readme provides instructions for building and running the app using Docker Compose.
Before proceeding, make sure you have the following installed on your machine:
- Docker
- Docker Compose
The initial brainstorming for the echomail app was done on Whimsical. You can find the diagram here.
To build the echomail app, follow these steps:
- Clone the repository to your local machine.
- Navigate to the project directory.
- Open a terminal or command prompt.
- Run the following command to build the Docker image:
docker build -t app-name .
To run the echomail app using Docker Compose, follow these steps:
- Make sure you are in the project directory.
- Open the
docker-compose.yml
file. - Add the necessary environment variables under the
environment
section. - Save the file.
- Open a terminal or command prompt.
- Run the following command to start the containers:
docker-compose up -d
Before accessing the app, you need to expose the local port using ngrok. Follow these steps:
- Make sure the containers are up and running.
- Open a terminal or command prompt.
- Run the following command to expose the port:
ngrok http port
Replace `port` with the port specified in the Docker Compose file.
- Once ngrok is running, you can access the app by opening a web browser and navigating to the provided ngrok URL.