Getting Started

Let's create a new Nitro app in few steps.

Play Online

Open on StackblitzOpen on CodeSandbox

Starter Template

Make sure you have installed the recommended setup:

Create a new project using starter template:

npx giget@latest nitro nitro-app
pnpm dlx giget@latest nitro nitro-app
cd nitro-app

Install the dependencies:

npm install
yarn install
pnpm install

Start the development server:

npm run dev

๐Ÿช„ Your API is ready at http://localhost:3000/

Check .nitro/dev/index.mjs if want to know what is happening

Build your production-ready server:

npm run build

Output is in the .output directory and ready to be deployed on almost any provider with no dependencies.

You can try it locally with:

npm run preview

Edge Release Channel

Nitro offers an edge release channel that automatically releases for every commit to main branch.

You can opt-in to the edge release channel by updating your package.json:

  "devDependencies": {
--    "nitropack": "^2.0.0"
++    "nitropack": "npm:nitropack-edge@latest"

Remove an lockfile (package-lock.json, yarn.lock, or pnpm-lock.yaml) and reinstall the dependencies.