Update setup docs and scripts

Refresh setup docs, add ZXDB local setup script, and note deploy rules.

Signed-off-by: codex@lucy.xalior.com
This commit is contained in:
2026-01-10 22:52:27 +00:00
parent 89d48edbd9
commit 9bb0a18695
8 changed files with 62 additions and 9 deletions

View File

@@ -15,6 +15,12 @@ Run in development
- Command: pnpm dev
- Then open: http://localhost:4000
ZXDB submodule local setup
- The ZXDB repo is a submodule used as a read-only reference for schemas/scripts.
- Some local SQL files are expected to exist but should stay untracked.
- Run: pnpm setup:zxdb-local
- This adds local excludes inside the submodule so `git status` stays clean.
Build and start (production)
- Build: pnpm build
- Start: pnpm start
@@ -24,7 +30,9 @@ Lint
- pnpm lint
Deployment shortcuts
- Two scripts are available in package.json:
- Use pnpm deploy (or pnpm deploy:branch) to merge the current branch into `deploy` and push to explorer.specnext.dev.
- The deploy script refuses to run if there are uncommitted or untracked files.
- One-step push helpers (if you prefer manual branch selection):
- pnpm deploy-test: push the current branch to test.explorer.specnext.dev
- pnpm deploy-prod: push the current branch to explorer.specnext.dev
Ensure the corresponding Git remotes are configured locally before using these.
- Ensure the corresponding Git remotes are configured locally before using these.