Guides · 01

Quickstart.

Bootstrap a Nimbus project and run it locally in under a minute.

Install the CLI

bash
npm install -g @nimbus/cli
nimbus --version

Create a new project

  1. Pick a folder for your project and run nimbus init.
  2. Choose the starter template you'd like to use.
  3. Install dependencies and start the dev server.
bash
nimbus init my-app
cd my-app
npm install
nimbus dev

The dev server listens on http://localhost:4000 by default. Edit any file under src/ and changes hot-reload in the browser.

Project layout
A fresh project ships with a src/ folder, a nimbus.config.ts, and a small test suite. Nothing is hidden — open any file to see how it works.
Keep secrets out of source
Anything in .env.public ships to the browser. Real secrets belong in .env.local, which the CLI never bundles.