From 83e2cabbcc8024958646e2b4f2cabc52200e2ff3 Mon Sep 17 00:00:00 2001 From: Brandon Rothweiler Date: Thu, 17 Nov 2022 00:30:58 -0500 Subject: [PATCH] Update contribution-guidelines.md (#985) --- docs/docs/contribution-guidelines.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/docs/contribution-guidelines.md b/docs/docs/contribution-guidelines.md index 533530e400ff8..3587dc5a4c1d3 100644 --- a/docs/docs/contribution-guidelines.md +++ b/docs/docs/contribution-guidelines.md @@ -20,12 +20,19 @@ This environment includes the following services: All the services are packaged to run as with single Docker Compose command. -After cloning the project, from the root directory run +### Instructions + +1. Clone the project repo. +2. Run `cp docker/.env.example docker/.env`. +3. Edit `docker/.env` to provide values for the required variables `UPLOAD_LOCATION` and `JWT_SECRET`. +4. From the root directory, run: ```bash title="Start development server" make dev # required Makefile installed on the system. ``` +5. Access the dev instance in your browser at http://localhost:2283, or connect via the mobile app. + All the services will be started with hot-reloading enabled for a quick feedback loop. You can access the web from `http://your-machine-ip:2283` or `http://localhost:2283` and access the server from the mobile app at `http://your-machine-ip:2283/api`