You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
90 lines
1.9 KiB
90 lines
1.9 KiB
# create-vite <a href="https://npmjs.com/package/create-vite"><img src="https://img.shields.io/npm/v/create-vite" alt="npm package"></a>
|
|
|
|
## Scaffolding Your First Vite Project
|
|
|
|
> **Compatibility Note:**
|
|
> Vite requires [Node.js](https://nodejs.org/en/) 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:
|
|
|
|
```bash
|
|
npm create vite@latest
|
|
```
|
|
|
|
With Yarn:
|
|
|
|
```bash
|
|
yarn create vite
|
|
```
|
|
|
|
With PNPM:
|
|
|
|
```bash
|
|
pnpm create vite
|
|
```
|
|
|
|
With Bun:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
# 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](https://github.com/vitejs/awesome-vite#templates) that include other tools or target different frameworks. You can use a tool like [degit](https://github.com/Rich-Harris/degit) to scaffold your project with one of the templates.
|
|
|
|
```bash
|
|
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`
|
|
|
|
```bash
|
|
npx degit user/project#main my-project
|
|
```
|