nx/packages/vite/docs/init-examples.md
Isaac Mann afa5eb59fa
docs(core): document the @nrwl => @nx rescope (#16403)
Co-authored-by: FrozenPandaz <jasonjean1993@gmail.com>
2023-04-27 18:14:59 -04:00

33 lines
1.3 KiB
Markdown

---
title: Examples for the Vite init generator
description: This page contains examples for the Vite @nx/vite:init generator, which helps you initialize vite in your Nx workspace, by installing the necessary dependencies.
---
This is a generator will initialize Vite.js in your workspace. It will install all the necessary dependencies. You can read more about how this generator works, in the [Vite package overview page](/packages/vite).
{% callout type="note" title="string" %}
You don't need to use this generator on its own.
{% /callout %}
This generator will be called automatically when you are either converting an existing React or Web app to use Vite, using the [`@nx/vite:configuration` generator](/packages/vite/generators/configuration), or when you are creating a new React or Web app using the [`@nx/react:app`](/packages/react/generators/application) or [`@nx/web:app`](/packages/web/generators/application) generators, if you choose `vite` as the `bundler`.
If you need to for some reason, you can use it on its own like this:
```bash
nx g @nx/vite:init
```
## Examples
### Install all the necessary dependencies for Vite and the React plugin
```bash
nx g @nx/vite:init --uiFramework=react
```
### Install all the necessary dependencies for Vite
```bash
nx g @nx/vite:init --uiFramework=none
```