717f78b29c
- adds the necessary dependencies and configuration for Storybook. - refactors the `Button` component and adds some stories for it.
44 lines
1.2 KiB
Markdown
44 lines
1.2 KiB
Markdown
## Usage
|
|
|
|
Those templates dependencies are maintained via [pnpm](https://pnpm.io) via
|
|
`pnpm up -Lri`.
|
|
|
|
This is the reason you see a `pnpm-lock.yaml`. That being said, any package
|
|
manager will work. This file can be safely be removed once you clone a template.
|
|
|
|
```bash
|
|
$ npm install # or pnpm install or yarn install
|
|
```
|
|
|
|
### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
|
|
|
|
## Available Scripts
|
|
|
|
In the project directory, you can run:
|
|
|
|
### `npm run dev` or `npm start`
|
|
|
|
Runs the app in the development mode.<br> Open
|
|
[http://localhost:3000](http://localhost:3000) to view it in the browser.
|
|
|
|
The page will reload if you make edits.<br>
|
|
|
|
### `npm run build`
|
|
|
|
Builds the app for production to the `dist` folder.<br> It correctly bundles
|
|
Solid in production mode and optimizes the build for the best performance.
|
|
|
|
The build is minified and the filenames include the hashes.<br> Your app is
|
|
ready to be deployed!
|
|
|
|
### `npm run storybook`
|
|
|
|
Starts an instance of [storybook](https://storybook.js.org/).
|
|
|
|
For more info on how to write stories, please [see here](https://storybook.js.org/docs).
|
|
|
|
## Deployment
|
|
|
|
You can deploy the `dist` folder to any static host provider (netlify, surge,
|
|
now, etc.)
|