Quickstart
These instructions assume macOS / Linux.
Windows users can follow the same steps inside WSL 2.
1 · Clone & install dependencies
git clone <your-fork-url>
cd <project-root>
pnpm install2 · Environment variables
cp .env.example .env
# then open .env and fill in the missing secretsAt minimum you will need valid OpenAI keys if you intend to test the AI features locally.
3 · Start the dev server
pnpm devOutput should end with something like:
ready - started server on 0.0.0.0:3000, url: http://localhost:3000• Main app: http://localhost:3000
• Docs site: http://localhost:3000/docs
Both apps run in the same Next.js instance – there is no need to launch two separate processes.
4 · Common dev commands
| Command | Purpose |
|---|---|
pnpm dev | Hot-reloading development server |
pnpm build | Production build (app and docs) |
pnpm lint | TypeScript, ESLint & MDX checks |
pnpm test | Jest / vitest (if present) |
5 · Next steps
Play with components
Open components/ and tweak something – the browser auto reloads.
Explore the API routes
Visit /api/iss in the browser – you should see live JSON from the International Space Station.
Add a new documentation page
Follow the Documentation Authoring guide → create src/content/my-page.mdx → refresh /docs.
You are now set! 🚀
Last updated on