# Got a question? / Need help?
Join [solid discord](https://discord.com/invite/solidjs) and check the [troubleshooting section](#troubleshooting) to see if your question hasn't been already answered.
## Features
- HMR with no configuration needed
- Drop-in installation as a vite plugin
- Minimal bundle size
- Support typescript (`.tsx`) out of the box
- Support code splitting out of the box
## Requirements
This module 100% esm compatible. As per [this document](https://nodejs.org/api/esm.html) it is strongly recommended to have at least the version `14.13.0` of node installed.
You can check your current version of node by typing `node -v` in your terminal. If your version is below that one version I'd encourage you to either do an update globally or use a node version management tool such as [volta](https://volta.sh/) or [nvm](https://github.com/nvm-sh/nvm).
## Quickstart
You can use the [vite-template-solid](https://github.com/solidjs/templates) starter templates similar to CRA:
```bash
$ npx degit solidjs/templates/js my-solid-project
$ cd my-solid-project
$ npm install # or pnpm install or yarn install
$ npm run start # starts dev-server with hot-module-reloading
$ npm run build # builds to /dist
```
## Installation
Install `vite`, `vite-plugin-solid` and `babel-preset-solid` as dev dependencies.
Install `solid-js` as dependency.
You have to install those so that you are in control to which solid version is used to compile your code.
```bash
# with npm
$ npm install -D vite vite-plugin-solid babel-preset-solid
$ npm install solid-js
# with pnpm
$ pnpm add -D vite vite-plugin-solid babel-preset-solid
$ pnpm add solid-js
# with yarn
$ yarn add -D vite vite-plugin-solid babel-preset-solid
$ yarn add solid-js
```
Add it as plugin to `vite.config.js`
```js
// vite.config.ts
import { defineConfig } from 'vite';
import solidPlugin from 'vite-plugin-solid';
export default defineConfig({
plugins: [solidPlugin()],
});
```
## Run
Just use regular `vite` or `vite build` commands
```json
{
"scripts": {
"dev": "vite",
"build": "vite build"
}
}
```
## API
### options
- Type: Object
- Default: {}
#### options.dev
- Type: Boolean
- Default: true
This will inject `solid-js/dev` in place of `solid-js` in dev mode. Has no effect in prod.
If set to false, it won't inject it in dev.
This is useful for extra logs and debug.
#### options.hot
- Type: Boolean
- Default: true
This will inject HMR runtime in dev mode. Has no effect in prod.
If set to false, it won't inject the runtime in dev.
#### options.ssr
- Type: Boolean
- Default: false
This will force SSR code in the produced files. This is experiemental and mostly not working yet.
#### options.babel
- Type: Babel.TransformOptions
- Default: {}
Pass any additional [babel transform options](https://babeljs.io/docs/en/options). Those will be merged with the transformations required by Solid.
#### options.solid
- Type: [babel-plugin-jsx-dom-expressions](https://github.com/ryansolid/dom-expressions/tree/main/packages/babel-plugin-jsx-dom-expressions#plugin-options)
- Default: {}
Pass any additional [babel-plugin-jsx-dom-expressions](https://github.com/ryansolid/dom-expressions/tree/main/packages/babel-plugin-jsx-dom-expressions#plugin-options).
They will be merged with the defaults sets by [babel-preset-solid](https://github.com/solidjs/solid/blob/main/packages/babel-preset-solid/index.js#L8-L25).
#### options.typescript
- Type: [@babel/preset-typescript](https://babeljs.io/docs/en/babel-preset-typescript)
- Default: {}
Pass any additional [@babel/preset-typescript](https://babeljs.io/docs/en/babel-preset-typescript).
## Note on HMR
Starting from version `1.1.0`, this plugin handle automatic HMR via [solid-refresh](https://github.com/solidjs/solid-refresh).
At this stage it's still early work but provide basic HMR. In order to get the best out of it there are couple of things to keep in mind:
- When you modify a file every state below this component will be reset to default state (including the current file). The state in parent component is preserved.
- The entrypoint can't benefit from HMR yet and will force a hard reload of the entire app. This is still really fast thanks to browser caching.
If at least one of this point is blocking to you, you can revert to the old behavior but [opting out the automatic HMR](#options) and placing the following snippet in your entry point:
```jsx
const dispose = render(() =>