Skip to content

feat: enable 1-minute zero-config onboarding and move advanced docs t…#142

Open
Kshitizjain11 wants to merge 1 commit intoRocketChat:masterfrom
Kshitizjain11:feat/one-minute-quickstart-defaults
Open

feat: enable 1-minute zero-config onboarding and move advanced docs t…#142
Kshitizjain11 wants to merge 1 commit intoRocketChat:masterfrom
Kshitizjain11:feat/one-minute-quickstart-defaults

Conversation

@Kshitizjain11
Copy link
Copy Markdown

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:

  • A faster "Get It Running" path
  • Default config usage (CONTRIB data) to avoid manual setup
  • A shorter quickstart (3 lines or less)
  • Moving confusing sections (config reference, local development, REST API) to docs

Changes

File What changed
README.md Replaced 5-minute setup with a 3-command quickstart using built-in demo defaults; removed advanced setup noise
getting-started.md Added organized advanced setup content: config reference, local dev workflow, REST API pointer
docs/rest-api.md REST API docs moved here; root REST-API.md removed to avoid duplicate entry points
app.js Auto-creates config.json from config-example.json when missing; demo-safe defaults when .env is absent
refresh.js Auto-creates config.json when missing; repairs missing/empty/invalid data.json and log.json instead of crashing
API.js Makes AUTH_TOKEN optional — authorization header only added when present, enabling no-.env demo runs
AGENTS.md, GEMINI.md Updated references to match new docs locations and startup behavior

Tests

npm run lint          # passes
npm test              # passes (2/2)
NODE_OPTIONS=--openssl-legacy-provider npm run build   # passes (non-blocking webpack size warnings)

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 serve

Checklist

  • Read and understood all changed code paths
  • Lint passes
  • Tests pass
  • Build passes
  • Manual backend smoke test passes
  • Scope matches maintainer issue requirements

AI-assisted contribution disclosure: Mostly AI-generated.

…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)
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Apr 11, 2026

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve "out of box" experience

2 participants