| 1 | # SolidStart |
| 2 | |
| 3 | Everything you need to build a Solid project, powered by [`solid-start`](https://start.solidjs.com); |
| 4 | |
| 5 | ## Creating a project |
| 6 | |
| 7 | ```bash |
| 8 | # create a new project in the current directory |
| 9 | npm init solid@latest |
| 10 | |
| 11 | # create a new project in my-app |
| 12 | npm init solid@latest my-app |
| 13 | ``` |
| 14 | |
| 15 | ## Developing |
| 16 | |
| 17 | Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: |
| 18 | |
| 19 | ```bash |
| 20 | npm run dev |
| 21 | |
| 22 | # or start the server and open the app in a new browser tab |
| 23 | npm run dev -- --open |
| 24 | ``` |
| 25 | |
| 26 | ## Building |
| 27 | |
| 28 | Solid apps are built with _presets_, which optimise your project for deployment to different environments. |
| 29 | |
| 30 | By default, `npm run build` will generate a Node app that you can run with `npm start`. To use a different preset, add it to the `devDependencies` in `package.json` and specify in your `app.config.js`. |
| 31 | |
| 32 | ## This project was created with the [Solid CLI](https://github.com/solidjs-community/solid-cli) |