From 58be4801ba5ef87169baba3aa47aa7ce127db0f1 Mon Sep 17 00:00:00 2001 From: Alex Holliday Date: Sun, 8 Sep 2024 14:37:21 -0700 Subject: [PATCH] revise order of readme --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ce9d1dbf8..92ee37e35 100644 --- a/README.md +++ b/README.md @@ -170,7 +170,15 @@ The fastest way to start the application is to use our Dockerfiles and [Docker C To get the application up and running you need to: 1. In the `Docker` directory run the build script `build_images.sh` to build docker images for the client, server, Redis database, and MongoDB database. -2. In the `Docker` directory, create a `server.env` file with the [requried environtmental variables](#env-vars-server) for the server. Sample file: + +2. In the `Dokcer` directory create a `mongo.env` file with a username and password: + +``` +USERNAME_ENV_VAR=user +PASSWORD_ENV_VAR=password +``` + +3. In the `Docker` directory, create a `server.env` file with the [requried environtmental variables](#env-vars-server) for the server. Sample file: ``` CLIENT_HOST="http://localhost:5173" @@ -187,21 +195,14 @@ SYSTEM_EMAIL_ADDRESS= SYSTEM_EMAIL_PASSWORD= ``` -3. In the `Client` directory, create a `client.env` file with the [required environtmental variables](#env-vars-client) for the client. Sample file: +4. In the `Client` directory, create a `client.env` file with the [required environtmental variables](#env-vars-client) for the client. Sample file: ``` VITE_APP_API_BASE_URL="http://localhost:5000/api/v1" VITE_APP_API_LOG_LEVEL="debug" ``` -3. In the `Dokcer` directory create a `mongo.env` file with a username and password: - -``` -USERNAME_ENV_VAR=user -PASSWORD_ENV_VAR=password -``` - -4. In the `Docker` directory run `docker compose up` to run the `docker-compose.yaml` file and start all four images. +5. In the `Docker` directory run `docker compose up` to run the `docker-compose.yaml` file and start all four images. That's it, the application is ready to use on port 80.