feat(registers): deep‑linkable search via ?q=; docs: add docs/ and update README
- Register Explorer:
- Sync search input with URL query param `q` for shareable deep links
- Initialize search from `q` on load; update URL on input; remove `q` when cleared
- Implemented with Next.js `useSearchParams`, `useRouter`, `usePathname`
- File: src/app/registers/RegisterBrowser.tsx
- Documentation:
- Add docs/ hub and initial guides
- docs/index.md (docs index)
- docs/getting-started.md (install/dev/build/start/lint/deploy)
- docs/architecture.md (structure, theming, styling, key paths, scripts)
- docs/registers.md (Register Explorer overview, search, deep links, implementation notes)
- Rewrite README.md with project overview, features, quick start, scripts, and links to docs
Notes:
- Dev server uses port 4000 (Turbopack) via package.json
- Example deep link: /registers?q=vram
Date: 2025-12-11 13:11 (Junie@lucy.xalior.com)
This commit is contained in:
60
README.md
60
README.md
@@ -1,36 +1,36 @@
|
||||
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
|
||||
Spectrum Next Explorer
|
||||
|
||||
## Getting Started
|
||||
A Next.js application for exploring the Spectrum Next hardware. It includes a Register Explorer with real‑time search and deep‑linkable queries.
|
||||
|
||||
First, run the development server:
|
||||
Features
|
||||
- Register Explorer parsed from `data/nextreg.txt`
|
||||
- Real‑time filtering with query‑string deep links (e.g. `/registers?q=vram`)
|
||||
- Bootstrap 5 theme with light/dark support
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
# or
|
||||
pnpm dev
|
||||
# or
|
||||
bun dev
|
||||
```
|
||||
Quick start
|
||||
- Prerequisites: Node.js 20+, pnpm (recommended)
|
||||
- Install dependencies:
|
||||
- `pnpm install`
|
||||
- Run in development (Turbopack, port 4000):
|
||||
- `pnpm dev` then open http://localhost:4000
|
||||
- Build and start (production):
|
||||
- `pnpm build`
|
||||
- `pnpm start` (defaults to http://localhost:3000)
|
||||
- Lint:
|
||||
- `pnpm lint`
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
Project scripts (package.json)
|
||||
- `dev`: `PORT=4000 next dev --turbopack`
|
||||
- `build`: `next build --turbopack`
|
||||
- `start`: `next start`
|
||||
- `deploy-test`: push to `test.explorer.specnext.dev`
|
||||
- `deploy-prod`: push to `explorer.specnext.dev`
|
||||
|
||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
||||
Documentation
|
||||
- Docs index: `docs/index.md`
|
||||
- Getting Started: `docs/getting-started.md`
|
||||
- Architecture: `docs/architecture.md`
|
||||
- Register Explorer: `docs/registers.md`
|
||||
|
||||
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
|
||||
|
||||
## Learn More
|
||||
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
||||
|
||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
|
||||
|
||||
## Deploy on Vercel
|
||||
|
||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
||||
|
||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
|
||||
License
|
||||
- See `LICENSE.txt` for details.
|
||||
|
||||
Reference in New Issue
Block a user