Simplify README setup instructions and add local.js (fixes #500) #2494
Conversation
Summary by CodeRabbit
WalkthroughThe README.md Prerequisites section has been updated to replace a single-line instruction with a detailed, multi-step setup guide. The new guide includes explicit steps for creating a local.js configuration file, a ready-to-copy snippet from development.js, and documented GitHub OAuth credential configuration while preserving existing Firestore and Firebase emulator guidance. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![korbit-ai[bot]](https://avatars.githubusercontent.com/in/322216?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🔇 Additional comments (1)
README.md (1)
24-27: LGTM! Clear, beginner-friendly setup instructions.The new multi-step approach with explicit guidance to copy from
config/development.jsand then update OAuth credentials significantly improves clarity compared to the previous single-line instruction. This should reduce friction for new contributors.
| ```js | ||
| clientId: "<YOUR_GITHUB_CLIENT_ID>", | ||
| clientSecret: "<YOUR_GITHUB_CLIENT_SECRET> | ||
| " |
There was a problem hiding this comment.
Fix syntax error in the code snippet.
The closing quote for clientSecret is malformed. Line 31 ends without a closing quote, and line 32 contains a stray " character. This provides broken code to users attempting to follow the setup guide.
Apply this diff to correct the syntax error:
```js
clientId: "<YOUR_GITHUB_CLIENT_ID>",
-clientSecret: "<YOUR_GITHUB_CLIENT_SECRET>
-"
+clientSecret: "<YOUR_GITHUB_CLIENT_SECRET>"
<details>
<summary>🤖 Prompt for AI Agents</summary>
In README.md around lines 29 to 32, the clientSecret string is broken across
lines leaving a missing closing quote and a stray quote on the next line; fix by
putting the entire clientSecret value on one line with matching opening and
closing quotes so it reads clientSecret: "<YOUR_GITHUB_CLIENT_SECRET>" (remove
the stray newline and extra quote).
</details>
<!-- This is an auto-generated comment by CodeRabbit -->
1 participant
This pull request simplifies the setup steps in the README to make it easier for new contributors to get started.
Changes made:
Added clear instructions for creating config/local.js
Included example for GitHub OAuth credentials (clientId and clientSecret)
Made setup steps more beginner-friendly
Why this change was needed:
The previous README was confusing for first-time contributors.
The new instructions clearly explain each step and help users set up the project faster.
Testing:
Followed the updated README to verify that setup works locally.
Description by Korbit AI
What change is being made?
Simplify local setup instructions in README and add guidance to create config/local.js by copying config/development.js and updating GitHub OAuth credentials, including a code snippet for clientId and clientSecret.
Why are these changes being made?
To streamline local onboarding and reduce manual configuration steps, addressing setup friction and the related issue (#500).