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:
@@ -22,6 +22,9 @@ Project scripts (package.json)
|
||||
- `dev`: `PORT=4000 next dev --turbopack`
|
||||
- `build`: `next build --turbopack`
|
||||
- `start`: `next start`
|
||||
- `deploy`: merge current branch into `deploy` and push to `explorer.specnext.dev`
|
||||
- `deploy:branch`: same as `deploy`, but accepts a deploy branch argument
|
||||
- `setup:zxdb-local`: configure local submodule excludes for ZXDB SQL files
|
||||
- `deploy-test`: push to `test.explorer.specnext.dev`
|
||||
- `deploy-prod`: push to `explorer.specnext.dev`
|
||||
|
||||
@@ -59,6 +62,10 @@ The Registers section works without any database. The ZXDB Explorer requires a M
|
||||
3) Run the app
|
||||
- `pnpm dev` → open http://localhost:4000 and navigate to `/zxdb`.
|
||||
|
||||
4) Keep the ZXDB submodule clean (recommended)
|
||||
- Run `pnpm setup:zxdb-local` once after cloning.
|
||||
- This keeps `ZXDB/ZXDB_mysql.sql` and `ZXDB/ZXDB_mysql_STRUCTURE_ONLY.sql` available locally without appearing as untracked changes.
|
||||
|
||||
API (selected endpoints)
|
||||
- `GET /api/zxdb/search?q=...&page=1&pageSize=20&genreId=...&languageId=...&machinetypeId=...&sort=title&facets=1`
|
||||
- `GET /api/zxdb/entries/[id]`
|
||||
|
||||
Reference in New Issue
Block a user