more instructions on native dev

Author: lihebi

README.md

@@ -4,7 +4,9 @@
 
 # Development
 
-Add a .env file to `./api/.env`, `./dev/.env` with the following:
+## Setup DB credentials
+
+Add a .env file to `./api/.env`, `./dev/.env` with the following credentials:
 
 ```shell
 POSTGRES_USER=YOUR_USERNAME
@@ -14,31 +16,50 @@ JWT_SECRET=YOUR_SUPER_SECRET_KEY
 DATABASE_URL="postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@localhost:5432/$POSTGRES_DB?schema=public"
 ```
 
-Then, start the DB service on localhost:5432
+- `dev/.env` is used to setup the DB with correct credentials
+- `api/.env` is used by the backend API to talk to the DB.
+
+## Setup DB
+
+Note: to avoid installing docker on your local machine, you could launch the DB
+service on a remote Linux server. You'll need to change the DATABASE_URL in the .env files.
+
+To start the DB service on localhost:5432, install docker and run:
 
 ```
-cd ./dev
+cd dev
 docker compose up -d
 ```
 
 If you haven't initialized the DB for the first time, do the initialization:
 
-```
-cd ./api
+```shell
+cd api
 npx prisma migrate dev --name init
 ```
 
-Start the API server on http://localhost:4000:
+You might also need to generate the prisma client (the above command will generate the client. You only need this if you are using a remote DB):
 
+```shell
+cd api
+npx prisma generate
 ```
-cd ./api
+
+## Start the app
+
+Start the API server on http://localhost:4000:
+
+```shell
+cd api
+yarn # install deps
 yarn dev
 ```
 
 Start the UI server on http://localhost:3000:
 
-```
-cd ./ui
+```shell
+cd ui
+yarn # install deps
 yarn dev
 ```