From 6b419a984c14d8670e185547240b3f66ad9bc7a0 Mon Sep 17 00:00:00 2001
From: Aram Akhavan <github@aram.nubmail.ca>
Date: Sun, 21 Jan 2024 14:32:01 -0800
Subject: [PATCH] doc: developer setup docs (#6557)

---
 docs/docs/developer/setup.md | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/docs/docs/developer/setup.md b/docs/docs/developer/setup.md
index fcdf5867ac..d311f9ca41 100644
--- a/docs/docs/developer/setup.md
+++ b/docs/docs/developer/setup.md
@@ -35,18 +35,22 @@ All the services are packaged to run as with single Docker Compose command.
 1. Clone the project repo.
 2. Run `cp docker/example.env docker/.env`.
 3. Edit `docker/.env` to provide values for the required variable `UPLOAD_LOCATION`.
-4. From the root directory, run:
+4. Install the required dependencies (nodejs >20, a modern java version e.g. OpenJDK 17)
+5. From the root directory, run:
 
 ```bash title="Start development server"
+make open-api # this is the only step that requires the above dependencies
 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.
+6. 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`
 
+**Note:** the "web" development container runs with uid 1000. If that uid does not have read/write permissions on the mounted volumes, you may encounter errors
+
 ### Mobile app
 
 The mobile app `(/mobile)` will required Flutter toolchain 3.13.x to be installed on your system.