Merge branch 'main' into mslwang/LLSC-51-add-startup-logs

Author: ebwu95

README.md

@@ -64,18 +64,18 @@ git clone https://github.com/uwblueprint/llsc.git
 cd llsc
 ```
 
-- Create a .env file in the root directory based on the .env.sample file. Update
+- Create a .env file in `./backend` and `./frontend` based on the .env.sample file. Update
   the environment variables as needed. Consult the [Secrets](#secrets) section
   for detailed instructions.
 
 ```bash
 cp .env.sample .env
 ```
 
-- Build and start the Docker containers
+- Build and start the Docker containers (in detached mode)
 
 ```bash
-docker-compose up --build
+docker-compose up -d
 ```
 
 - Install pdm (this is a global installation, so location doesn't matter)
@@ -85,6 +85,14 @@ brew install pdm
 ```
 Otherwise, feel free to follow install instructions [here](https://pdm-project.org/latest/#installation)
 
+- Install postgresql (this is for local development)
+On macOS:
+```bash
+brew install postgresql
+```
+Otherwise, feel free to follow install instructions [here](https://www.postgresql.org/download/)
+Note: you will need this for `psycopg2`, which requires a config file that is part of postgresql.
+
 You will then need to go into each directory individually to install dependencies.
 
 FastAPI backend

backend/app/server.py

@@ -2,12 +2,17 @@
 from contextlib import asynccontextmanager
 from typing import Union
 
+from backend.app.routes import send_email
+from dotenv import load_dotenv
 from fastapi import FastAPI
 
-from . import models
-from .routes import send_email, user
+load_dotenv()
+
+# we need to load env variables before initialization code runs
+from . import models  # noqa: E402
+from .routes import user  # noqa: E402
 from .utilities.constants import LOGGER_NAME
-from .utilities.firebase_init import initialize_firebase
+from .utilities.firebase_init import initialize_firebase  # noqa: E402
 
 log = logging.getLogger(LOGGER_NAME("server"))
 

docker-compose.yml

@@ -36,7 +36,7 @@ services:
       POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
       POSTGRES_DB: ${POSTGRES_DATABASE}
     healthcheck:
-      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER}"]
       interval: 5s
       timeout: 5s
       retries: 5