document that you need to run npm run build (#15)

* document that you need to run `npm run build` * update NOTE to use syntactic sugar --------- Co-authored-by: Dennis Chen <[email protected]>
kscalelabs · May 29, 2024 · 0f70ef4 · 0f70ef4
1 parent 81f2cb4
commit 0f70ef4
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -63,6 +63,9 @@ Serve the FastAPI application in development mode:
 fastapi dev 'store/app/main.py' --port 8080  # On port 8080 to avoid conflicts with Docker
 ```
 
+> [!NOTE]
+> You will need to run `npm run build` at least once in order to generate the static files in `frontend/build/static`.
+
 #### Configuration
 
 Settings for the app backend live in the `store/settings/` directory. You can use the following environment variables: