Add ngrok set-up instructions in README.md

uwblueprint · Jun 4, 2024 · b9e81d9 · b9e81d9
1 parent e577bd9
commit b9e81d9
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -106,6 +106,37 @@ Open Prisma studio:
 npx prisma studio
 ```
 
+## Ngrok
+### Set-up
+1. Create an [ngrok](https://dashboard.ngrok.com/signup) account
+
+2. Insert your personal ngrok authentication token in docker-compose.yml:
+```bash
+NGROK_AUTHTOKEN=<insert-your-token>
+```
+
+3. Run the application:
+```bash
+docker compose up --build
+```
+
+### Troubleshooting
+
+If another service is occupying port 5000, identify the PID of the service:
+```bash
+sudo lsof -i :5000
+```
+
+Kill the occupying service:
+```bash
+sudo kill <PID>
+```
+
+Run the application again:
+```bash
+docker compose up --build
+```
+
 ## The Team
 ### Term 1 (W24):
 **Project Lead:** N/A<br>

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -62,7 +62,7 @@ services:
     depends_on:
       - ts-backend
     environment:
-      - NGROK_AUTHTOKEN=2gqfbeXPRkhFsAGXsIpFZJCiitr_7VbDSwxB2h9Z6HbeK259K
+      - NGROK_AUTHTOKEN=<insert-your-token>
 
 volumes:
   postgres_data: