Welcome 👋

This short guide helps you clone, install and run the project in less than 5 minutes.
If you are looking for more in-depth material, head over to the Guides and Reference sections in the sidebar.

Project prerequisites

Tool	Version	Notes
Node.js	≥ 18	Required by `next` and the build step
pnpm	≥ 8	We use the fast, disk-efficient package manager
.env file	–	Copy `.env.example` → `.env` and fill in keys

⚠️

If you are using nvm make sure to nvm use the correct Node version before you run any commands.

➊ Install dependencies


pnpm install

➋ Local development


pnpm dev

When the server boots you should see two separate applications:

Main app – http://localhost:3000
Docs site – http://localhost:3000/docs

Changes in app/ (product) or in deep-wiki/src/content/ (docs) trigger hot-reload.

➌ Production build


pnpm build       # build everything (app _and_ docs)
pnpm start       # preview the output locally

➍ Project layout (quick tour)


app/                     ← Next.js (App Router)
└─ api/                  ← Edge & Serverless routes
components/              ← Re-usable UI building blocks
deep-wiki/               ← Documentation site (this folder)
└─ src/content/          ← **Your .mdx docs live here**
public/                  ← Static assets (images, fonts…)

For a detailed walk-through of the docs system itself, read the Documentation Authoring guide.

➎ Next steps

Explore the code

Open the app/ and components/ folders – each file is typed and documented.

Read the guides

Navigate to the Guides section for tutorials like Quickstart and Contributing.

Build something cool!

Clone a page from app/charts or components/solar-panel and start hacking.

Happy coding! ✨