Skip to content

Shivansh-Khunger/nitro

Repository files navigation

create-nitro npm package

nitro-logo

Scaffolding Your Node API's

Compatibility Note: Nitro requires Node.js version 18+, 20+. However, some templates require a higher Node.js version to work, please upgrade if your package manager warns about it.

Features

  • Templates: Quick setup for Node APIs with industry-standard templates.
  • Database Support: Easy integration with popular databases.
  • ORM Support: Support for ORMs like Mongoose and Prisma for easier database operations.
  • Linter Support: Includes linters like ESLint and Biome for cleaner, consistent code.

With NPM:

npm create nitro@latest

With Yarn:

yarn create nitro

With PNPM:

pnpm create nitro

Then follow the prompts!

You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a project, run:

# npm 7+, extra double-dash is needed:
npm create nitro@latest -- -t <template name> -d <directory name>

# yarn
yarn create nitro -t <template name> -d <directory name>

# pnpm
pnpm create nitro -t <template name> -d <directory name>

Currently supported template presets include:

  • express/js
  • express/ts

Note: For additional options, you would have to use the normal command mentioned prior.

ezgif-com-optimize