feat: enable 1-minute zero-config onboarding and move advanced docs t…#142
Open
Kshitizjain11 wants to merge 1 commit intoRocketChat:masterfrom
Open
feat: enable 1-minute zero-config onboarding and move advanced docs t…#142Kshitizjain11 wants to merge 1 commit intoRocketChat:masterfrom
Kshitizjain11 wants to merge 1 commit intoRocketChat:masterfrom
Conversation
…o docs/ - simplify README quickstart to a 3-command, 1-minute first run - auto-create src/server/config.json from config-example.json when missing - add demo-safe defaults so local run works without mandatory .env setup - harden refresh startup by recovering from empty/invalid cached JSON files - move advanced setup and REST API documentation to docs/ and update references (AGENTS/GEMINI)
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.
Overview
This PR improves the first-run experience to a true 1-minute onboarding and moves advanced setup details out of the main README. New users can run the project with defaults immediately, while customization docs remain available in the
docs/folder.Closes #141 — Improve first-run onboarding experience
Motivation
The maintainer issue requested:
Changes
README.mdgetting-started.mddocs/rest-api.mdREST-API.mdremoved to avoid duplicate entry pointsapp.jsconfig.jsonfromconfig-example.jsonwhen missing; demo-safe defaults when.envis absentrefresh.jsconfig.jsonwhen missing; repairs missing/empty/invaliddata.jsonandlog.jsoninstead of crashingAPI.jsAUTH_TOKENoptional — authorization header only added when present, enabling no-.envdemo runsAGENTS.md,GEMINI.mdTests
Manual smoke test — all endpoints pass:
curl http://localhost:62050/config curl http://localhost:62050/data curl http://localhost:62050/stats curl "http://localhost:62050/rank?parameter=mergedprs"How to verify
npm run add npm run lint npm test NODE_OPTIONS=--openssl-legacy-provider npm run build npm run serveChecklist