Skip to content

Latest commit

 

History

History
89 lines (64 loc) · 1.95 KB

README.md

File metadata and controls

89 lines (64 loc) · 1.95 KB
Raw

create-vite npm package

Scaffolding Your First Vite Project

Compatibility Note: Vite 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.

With NPM:

$ npm create vite@latest

With Yarn:

$ yarn create vite

With PNPM:

$ pnpm create vite

With Bun:

$ bun create vite

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 Vite + Vue project, run:

# npm 7+, extra double-dash is needed:
npm create vite@latest my-vue-app -- --template vue

# yarn
yarn create vite my-vue-app --template vue

# pnpm
pnpm create vite my-vue-app --template vue

# Bun
bun create vite my-vue-app --template vue

Currently supported template presets include:

  • vanilla
  • vanilla-ts
  • vue
  • vue-ts
  • react
  • react-ts
  • react-swc
  • react-swc-ts
  • preact
  • preact-ts
  • lit
  • lit-ts
  • svelte
  • svelte-ts
  • solid
  • solid-ts
  • qwik
  • qwik-ts

You can use . for the project name to scaffold in the current directory.

Community Templates

create-vite is a tool to quickly start a project from a basic template for popular frameworks. Check out Awesome Vite for community maintained templates that include other tools or target different frameworks. You can use a tool like degit to scaffold your project with one of the templates.

npx degit user/project my-project
cd my-project

npm install
npm run dev

If the project uses main as the default branch, suffix the project repo with #main

npx degit user/project#main my-project