Revised README for prerequisites and environment setup#148
Revised README for prerequisites and environment setup#148vishnu-v-vardhan wants to merge 3 commits into
Conversation
Updated prerequisites and environment setup instructions in README.
…pdate Revise README for prerequisites and environment setup
|
@vishnu-v-vardhan is attempting to deploy a commit to the Adam Team on Vercel. A member of the Team first needs to authorize it. |
Greptile SummaryThis PR replaces the old "Quick Start" block with a comprehensive, beginner-oriented setup guide covering prerequisites, environment configuration, step-by-step run instructions, API key acquisition, troubleshooting, and an updated tech stack section.
Confidence Score: 4/5The doc changes are safe but contain two internal contradictions that will actively mislead new contributors at setup time. The setup guide claims three terminal windows are needed but then introduces a fourth (ngrok) mid-step, leaving a beginner stuck. Separately, billing keys are described as only needed for billing flows in the Environment Setup section and then labelled required for normal local app flow in the API Keys section — a contributor who follows the first description will hit broken subscription prompts immediately with no guidance. README.md — the terminal count and billing-key framing need to be reconciled before this lands. Important Files Changed
Reviews (2): Last reviewed commit: "Enhance README with first-time setup and..." | Re-trigger Greptile |
Added beginner-friendly first-time setup instructions and detailed API key requirements for running the CADAM app locally.
| Open **3 terminal windows** in the project root (`CADAM`). | ||
|
|
||
| - Terminal A: Supabase local stack | ||
| - Terminal B: Supabase edge functions | ||
| - Terminal C: Frontend (Vite) |
There was a problem hiding this comment.
Terminal count stated as 3 but setup requires 4
The section header declares "Open 3 terminal windows" with three named terminals (A, B, C), but step 5 then instructs the contributor to use "Terminal A (new tab) or a Terminal D" for ngrok — introducing an implicit fourth terminal. Terminal A is already occupied with npx supabase start (a blocking process), so a beginner who opened exactly three windows will have no free slot when they hit step 5. The guide explicitly targets first-timers, so the mismatch between the upfront count and the actual requirement will cause real confusion at a critical setup step.
| - Billing variables are only needed for billing flows: | ||
| - `BILLING_SERVICE_URL` | ||
| - `BILLING_SERVICE_KEY` |
There was a problem hiding this comment.
Billing keys downplayed here, then flagged as required elsewhere
This "Environment Setup" section describes BILLING_SERVICE_URL and BILLING_SERVICE_KEY as "only needed for billing flows," which reads as optional. But the "API Keys (Beginner Guide)" section (line 253) explicitly headings them as "required for normal local app flow" and warns that omitting them causes subscription/token prompts on every action in local dev. A contributor who reads this section and skips the billing keys will hit a broken experience immediately, with no clear signal that this section understated the requirement.
There was a problem hiding this comment.
2 issues found across 1 file (changes from recent commits).
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="README.md">
<violation number="1" location="README.md:147">
P3: The header says "Open **3 terminal windows**" but step 5 requires a 4th terminal (Terminal A is occupied by `npx supabase start`). Since this guide targets first-time contributors, the mismatch will cause confusion. Update the count to 4 and list ngrok as Terminal D.</violation>
<violation number="2" location="README.md:265">
P1: Default local setup disables JWT verification for all served functions, including ones configured as auth-protected in `supabase/config.toml`.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
|
|
||
| ```bash | ||
| npm i | ||
| npx supabase functions serve --env-file supabase/functions/.env --no-verify-jwt |
There was a problem hiding this comment.
P1: Default local setup disables JWT verification for all served functions, including ones configured as auth-protected in supabase/config.toml.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At README.md, line 265:
<comment>Default local setup disables JWT verification for all served functions, including ones configured as auth-protected in `supabase/config.toml`.</comment>
<file context>
@@ -177,6 +218,97 @@ Open the app at:
+3. Restart function serve:
+
+```bash
+npx supabase functions serve --env-file supabase/functions/.env --no-verify-jwt
+```
+
</file context>
| npx supabase functions serve --env-file supabase/functions/.env --no-verify-jwt | |
| npx supabase functions serve --env-file supabase/functions/.env |
| Open **3 terminal windows** in the project root (`CADAM`). | ||
|
|
||
| - Terminal A: Supabase local stack | ||
| - Terminal B: Supabase edge functions | ||
| - Terminal C: Frontend (Vite) |
There was a problem hiding this comment.
P3: The header says "Open 3 terminal windows" but step 5 requires a 4th terminal (Terminal A is occupied by npx supabase start). Since this guide targets first-time contributors, the mismatch will cause confusion. Update the count to 4 and list ngrok as Terminal D.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At README.md, line 147:
<comment>The header says "Open **3 terminal windows**" but step 5 requires a 4th terminal (Terminal A is occupied by `npx supabase start`). Since this guide targets first-time contributors, the mismatch will cause confusion. Update the count to 4 and list ngrok as Terminal D.</comment>
<file context>
@@ -113,7 +142,13 @@ CADAM needs 2 environment files:
-## 🚀 Run Locally (Reliable Order)
+## 🚀 Run Locally (Step-by-Step)
+
+Open **3 terminal windows** in the project root (`CADAM`).
+
+- Terminal A: Supabase local stack
</file context>
| Open **3 terminal windows** in the project root (`CADAM`). | |
| - Terminal A: Supabase local stack | |
| - Terminal B: Supabase edge functions | |
| - Terminal C: Frontend (Vite) | |
| Open **4 terminal windows** in the project root (`CADAM`). | |
| - Terminal A: Supabase local stack | |
| - Terminal B: Supabase edge functions | |
| - Terminal C: Frontend (Vite) | |
| - Terminal D: ngrok tunnel |
Updated prerequisites and environment setup instructions in README.
Summary by cubic
Rewrote the README for a reliable local setup with a beginner-first guide, detailed API key requirements (minimum, optional, billing),
ngroksteps, explicit frontend and Supabase env setup, ordered run commands, seeded test account, troubleshooting, and an updated tech stack note (React 19 and related libs).Written for commit 46d74c0. Summary will update on new commits.