docs: fix local dev setup instructions#584
Open
jack-piplabs wants to merge 1 commit intoopenclaw:mainfrom
Open
docs: fix local dev setup instructions#584jack-piplabs wants to merge 1 commit intoopenclaw:mainfrom
jack-piplabs wants to merge 1 commit intoopenclaw:mainfrom
Conversation
- Add Node.js v18/20/22/24 prerequisite (Convex backend rejects v25+) - Remove duplicate CONVEX_SITE_URL from .env.local example - Reorder steps so Convex backend starts before auth/JWT setup - Add "Set backend environment variables" section (bunx convex env set) - Clarify that AUTH_GITHUB_ID/SECRET and SITE_URL must be set on the Convex backend, not just in .env.local - Make frontend port explicit (bun run dev -- --port 3000) - Add updateGlobalStatsInternal step after seeding
Contributor
|
@jack-piplabs is attempting to deploy a commit to the Amantus Machina Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
Greptile SummaryImproves the local development setup documentation with better prerequisite information, clearer environment variable handling, and more logical step ordering. Key improvements include:
All changes are documentation-only with no functional code modifications. The test plan confirms these instructions work end-to-end on a clean checkout. Confidence Score: 5/5
Last reviewed commit: 22d55a9 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CONVEX_SITE_URLfrom.env.localexample (Convex derives it fromVITE_CONVEX_SITE_URL)AUTH_GITHUB_ID,AUTH_GITHUB_SECRET, andSITE_URLmust be set viabunx convex env set, not just in.env.localbun run dev -- --port 3000) with a note about changing itupdateGlobalStatsInternalstep after seeding to refresh the cached skills countTest plan
bunx convex dev --typecheck=disablestarts the backendbunx convex env setcommands configure auth correctlyupdateGlobalStatsInternal