From 65e7cd820a60c2aab01135e7f6069aa3979f5953 Mon Sep 17 00:00:00 2001
From: Andrew Nguyen <ahn018@ucsd.edu>
Date: Fri, 19 Dec 2025 02:05:47 -0800
Subject: [PATCH] Add local setup to README

---
 README.md | 105 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 104 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 06e04e9..fd7e4bb 100644
--- a/README.md
+++ b/README.md
@@ -44,7 +44,110 @@ NEXT_PUBLIC_SUPABASE_URL=<your-supabase-project-url>
 NEXT_PUBLIC_SUPABASE_ANON_KEY=<your-public-anon-key>
 ```
 
-These keys are safe to expose to the browser but should be scoped to the realtime channel only via Supabase RLS/policies.
+
+### Local Supabase Development
+
+The repo includes a Supabase CLI project under `supabase/` with config and migrations, so you can run the full stack locally.
+
+#### 1. Prerequisites
+
+- Docker Desktop  
+  - **macOS**: https://docs.docker.com/desktop/install/mac-install/  
+  - **Windows**: https://docs.docker.com/desktop/install/windows-install/  
+  - After installing, start Docker Desktop and wait until it reports that Docker is running.
+- Supabase CLI  
+  - **macOS (Homebrew)**:
+
+    ```sh
+    brew install supabase/tap/supabase
+    ```
+
+  - **Windows (npm)** – requires Node.js:
+
+    ```sh
+    npm install -g supabase
+    ```
+
+  - Verify install (all platforms):
+
+    ```sh
+    supabase --version
+    ```
+
+#### 2. GitHub OAuth (local-only)
+
+To log in with GitHub against your local Supabase instance, you need a GitHub OAuth app:
+
+1. Go to `https://github.com/settings/developers` → **OAuth Apps** → **New OAuth App**
+2. Use these settings:
+   - **Application name**: `DEVx Local`
+   - **Homepage URL**: `http://localhost:3000`
+   - **Authorization callback URL**: `http://127.0.0.1:54321/auth/v1/callback`
+3. After creating the app, you'll see the **Client ID** immediately on the app's page. For the **Client secret**, click **"Generate a new client secret"** if you don't see one, then copy both values.
+4. Create `supabase/.env` (this file is git-ignored):
+
+   ```sh
+   cd supabase
+   cat > .env << 'EOF'
+   SUPABASE_AUTH_EXTERNAL_GITHUB_CLIENT_ID=your_client_id_here
+   SUPABASE_AUTH_EXTERNAL_GITHUB_SECRET=your_client_secret_here
+   EOF
+   ```
+
+> Note: The **Client ID** is visible on your OAuth app's page at `https://github.com/settings/developers` immediately after creating the app. The **Client secret** must be generated (or regenerated if lost) by clicking "Generate a new client secret" on the same page. If you've already created the app, you can find it listed under **OAuth Apps** and click on it to view or regenerate the credentials.
+
+`supabase/config.toml` is already configured to read these env vars via:
+
+```toml
+[auth.external.github]
+enabled = true
+client_id = "env(SUPABASE_AUTH_EXTERNAL_GITHUB_CLIENT_ID)"
+secret = "env(SUPABASE_AUTH_EXTERNAL_GITHUB_SECRET)"
+```
+
+#### 3. Start the local Supabase stack
+
+From the repo root:
+
+```sh
+supabase start
+```
+
+On success, you should see output including:
+
+- **Project URL**: `http://127.0.0.1:54321`
+- **Studio**: `http://127.0.0.1:54323`
+- **Database**: `postgresql://postgres:postgres@127.0.0.1:54322/postgres`
+
+If you change migrations or want a clean slate:
+
+```sh
+supabase stop
+supabase db reset   # WARNING: destroys local data, reapplies migrations
+supabase start
+```
+
+#### 4. Point the Next.js app at local Supabase
+
+Update `.env.local` in the project root:
+
+```sh
+NEXT_PUBLIC_SUPABASE_URL=http://127.0.0.1:54321
+NEXT_PUBLIC_SUPABASE_ANON_KEY=sb_publishable_ACJWlzQHlZjBrEguHvfOxg_3BJgxAaH
+```
+
+> Note: the `sb_publishable_...` key is printed in the `supabase start` output under “Authentication Keys → Publishable”.
+
+Restart the dev server after changing `.env.local`.
+
+#### 5. Common local issues
+
+- **`"no Route matched with those values"` at `127.0.0.1:54321`**  
+  This is normal for the bare API root. Use Studio (`http://127.0.0.1:54323`) or `http://localhost:3000` instead.
+- **`"Unsupported provider: provider is not enabled"` when logging in with GitHub**  
+  Ensure `[auth.external.github]` is present and `enabled = true` in `supabase/config.toml`, that `SUPABASE_AUTH_EXTERNAL_GITHUB_CLIENT_ID` and `SUPABASE_AUTH_EXTERNAL_GITHUB_SECRET` are set in `supabase/.env`, then run `supabase stop && supabase start`.
+- **Docker daemon errors (`Cannot connect to the Docker daemon`)**  
+  Make sure Docker Desktop is installed and running before you call `supabase start`.
 
 **Note: This project is being refactored to use styled-components exclusively. Please do not add new Tailwind classes. See [styling guidelines](./docs/conventions/styling-guidelines.md) for details.**