|
1 | | -This project was bootstrapped with [Create Solid](https://github.com/ryansolid/create-solid). Create Solid is a Fork of Create React App. |
2 | 1 |
|
3 | | -## Available Scripts |
4 | | - |
5 | | -In the project directory, you can run: |
6 | | - |
7 | | -### `npm start` |
| 2 | +# Example App |
8 | 3 |
|
9 | | -Runs the app in the development mode.<br> |
10 | | -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
11 | | - |
12 | | -The page will reload if you make edits.<br> |
13 | | -You will also see any lint errors in the console. |
| 4 | +This project was bootstrapped by following the |
| 5 | +[Solid Getting Started](https://www.solidjs.com/guides/getting-started) guide |
| 6 | +using to following command. |
14 | 7 |
|
15 | | -### `npm test` |
| 8 | +```bash |
| 9 | +npx degit solidjs/templates/ts solid |
| 10 | +``` |
16 | 11 |
|
17 | | -Launches the test runner in the interactive watch mode.<br> |
18 | | -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. |
| 12 | +## Usage |
19 | 13 |
|
20 | | -### `npm run build` |
| 14 | +Those templates dependencies are maintained via [pnpm](https://pnpm.io) via |
| 15 | +`pnpm up -Lri`. |
21 | 16 |
|
22 | | -Builds the app for production to the `build` folder.<br> |
23 | | -It correctly bundles Solid in production mode and optimizes the build for the best performance. |
| 17 | +This is the reason you see a `pnpm-lock.yaml`. That being said, any package |
| 18 | +manager will work. This file can be safely be removed once you clone a |
| 19 | +template. |
24 | 20 |
|
25 | | -The build is minified and the filenames include the hashes.<br> |
26 | | -Your app is ready to be deployed! |
| 21 | +```bash |
| 22 | +npm install # or pnpm install or yarn install |
| 23 | +``` |
27 | 24 |
|
28 | | -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. |
| 25 | +Learn more on the [Solid Website](https://solidjs.com) and come chat with us |
| 26 | +on our [Discord](https://discord.com/invite/solidjs) |
29 | 27 |
|
30 | | -### Code Splitting |
31 | | - |
32 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting |
33 | | - |
34 | | -### Analyzing the Bundle Size |
| 28 | +## Available Scripts |
35 | 29 |
|
36 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size |
| 30 | +In the project directory, you can run: |
37 | 31 |
|
38 | | -### Making a Progressive Web App |
| 32 | +### `npm run dev` or `npm start` |
39 | 33 |
|
40 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app |
| 34 | +Runs the app in the development mode. |
| 35 | +Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
41 | 36 |
|
42 | | -### Advanced Configuration |
| 37 | +The page will reload if you make edits. |
43 | 38 |
|
44 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration |
| 39 | +### `npm run build` |
45 | 40 |
|
46 | | -### Deployment |
| 41 | +Builds the app for production to the `dist` folder. |
| 42 | +It correctly bundles Solid in production mode and optimizes the build for the |
| 43 | +best performance. |
47 | 44 |
|
48 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/deployment |
| 45 | +The build is minified and the filenames include the hashes. |
| 46 | +Your app is ready to be deployed! |
49 | 47 |
|
50 | | -### `npm run build` fails to minify |
| 48 | +## Deployment |
51 | 49 |
|
52 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify |
| 50 | +You can deploy the `dist` folder to any static host provider |
| 51 | +(netlify, surge, now, etc.) |
0 commit comments