docs: local dev link to env vars (#5165)

EddieHubCommunity · Mar 1, 2023 · 89cab9b · 89cab9b
1 parent 68356ba
commit 89cab9b
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 8 deletions.
diff --git a/pages/docs/environments/gitpod.mdx b/pages/docs/environments/gitpod.mdx
@@ -6,6 +6,8 @@ In the cloud free development environment which will have all the dependencies y
 
 You can use Gitpod in the cloud.
 
+Setup environment [variables](/docs/environment-variables)
+
 [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/EddieHubCommunity/LinkFree/)
 
 export default ({ children }) => (

diff --git a/pages/docs/environments/local-development-docker-compose.mdx b/pages/docs/environments/local-development-docker-compose.mdx
@@ -11,23 +11,22 @@ You will need <Link href="https://docs.docker.com/compose/">Docker and Docker Co
 
 ### Setup
 
-1) Make sure you have cloned the repository and are in the root of the project.
-
-2) Execute the following command, this will build the images and start the containers.
+1. Make sure you have cloned the repository and are in the root of the project.
+2. Setup environment [variables](/docs/environment-variables)
+3. Execute the following command, this will build the images and start the containers.
 
 ```bash
 docker compose up
 ```
 
-3) You can now access the application at `http://localhost:3000`.
-
-4) If you make any changes to the dependencies, it's recommended to rebuild the images with the following command. 
+4. You can now access the application at `http://localhost:3000`.
+5. If you make any changes to the dependencies, it's recommended to rebuild the images with the following command.
 
 ```bash
 docker compose up --build
 ```
 
-5) If you want to stop the containers, you can use the following command.
+6. If you want to stop the containers, you can use the following command.
 
 ```bash
 docker compose down

diff --git a/pages/docs/environments/local-development.mdx b/pages/docs/environments/local-development.mdx
@@ -18,7 +18,7 @@ You can set this up locally with the following steps
 
 1. make sure Mongo is running
 1. install npm depenedencies with `npm ci`
-1. a new file will be created `.env` update any details required for example mongo connection string (but usually the default will work fine)
+1. a new file will be created `.env` update environment [variables](/docs/environment-variables)
 1. start the app with `npm run dev` and visit in the browser `http://localhost:3000`
 
 Any changes you make will automatically be reloaded in the browser.