From 6bfbea2d633af825bec33e95410268ee5b0ecf22 Mon Sep 17 00:00:00 2001 From: Steven Le Date: Sun, 26 Apr 2026 03:59:08 -0700 Subject: [PATCH] update README with Clark setup instructions + doc link --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d5e5ac..2a40875 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,34 @@ docker compose -f docker-compose.dev.yml up --build -d NOTE: To test SCEvents together with the frontend, you'll need to run Clark separately [following the instructions here](https://github.com/SCE-Development/Clark/wiki/Getting-Started) +### 3. Point Clark at your local SCEvents server + +If you want Clark to talk to a locally running SCEvents instance, update Clark's config so the SCEvents base URL points to port `8002`. + +In `Clark/src/config/config.json`: + +```json +{ + "SCEvents": { + "BASE_URL": "http://localhost:8002" + } +} +``` + +This is the local-development setting for running Clark and SCEvents as separate processes on your machine. + +For deployed environments behind Clark's nginx proxy, use: + +```json +{ + "SCEvents": { + "BASE_URL": "/api/scevents" + } +} +``` + ## Tech Stack -[Excalidraw](https://excalidraw.com/#json=blzinrcwsw_ZrNasTCHi5,2kjWQhJKEaD1ROrF5Nan3A) +- [SCEvents Documentation](https://docs.google.com/document/d/1K1va_5XcoPiI-ZY19f7KfWbIexqOdnR_RKz9MlP3C2U) +- [Excalidraw Diagrams](https://excalidraw.com/#json=blzinrcwsw_ZrNasTCHi5,2kjWQhJKEaD1ROrF5Nan3A) ![SCEvents Diagram](scevents.png)