explorer/docs/getting-started.md

Getting Started

This project is a Next.js app for exploring the Spectrum Next hardware. It uses the App Router, Bootstrap 5, and React-Bootstrap.

Prerequisites

• Node.js 20 or newer
• pnpm (recommended) or npm/yarn

Install

• pnpm install
  • or: npm install

Run in development

• The dev server runs on port 4000 using Turbopack
• 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
• Default start port: http://localhost:3000

Lint

• pnpm lint

Deployment shortcuts

• 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.