|
1 | 1 | ## Prerequisites
|
2 | 2 |
|
3 |
| -This project uses Node, npm, and [yarn](https://yarnpkg.org). We use [Storybook](https://storybook.js.org) for testing things visually, and [Docz](https://docz.site) for building a static documentation site. |
| 3 | +We use [Storybook](https://storybook.js.org) for testing things visually, and [Docz](https://docz.site) for building a static documentation site. |
4 | 4 |
|
5 | 5 | ## Installation
|
6 | 6 |
|
7 |
| -Clone this repository and run `yarn` in your project folder to install the necessary dependencies. |
| 7 | +Clone this repository and run `npm install` in your project folder to install the necessary dependencies. |
8 | 8 |
|
9 | 9 | ## Scripts
|
10 | 10 |
|
11 | 11 | ### Building
|
12 | 12 |
|
13 |
| -`yarn build` bundles the library with Rollup & Bublé, so that you can then `yarn publish` it. |
| 13 | +`npm run build` bundles the library with Rollup & Bublé, so that you can then `npm run publish` it. |
14 | 14 |
|
15 |
| -`yarn build:watch` continously builds the library while you work. This is useful if you `yarn link` the repository when using it in other projects locally. |
| 15 | +`npm run build:watch` continously builds the library while you work. This is useful if you `npm link` the repository when using it in other projects locally. |
16 | 16 |
|
17 | 17 | ### Storybook
|
18 | 18 |
|
19 |
| -`yarn storybook:start` starts Storybook on [`http://localhost:6001`](http://localhost:6001). |
| 19 | +`npm run storybook:start` starts Storybook on [`http://localhost:6001`](http://localhost:6001). |
20 | 20 |
|
21 |
| -`yarn storybook:build` creates a static version of the Storybook in `.storybook/dist`. |
| 21 | +`npm run storybook:build` creates a static version of the Storybook in `.storybook/dist`. |
22 | 22 |
|
23 | 23 | ### Docz
|
24 | 24 |
|
25 |
| -`docs:start` starts Docz on [`http://localhost:3000`](http://localhost:3000). |
| 25 | +`npm run docs:start` starts Docz on [`http://localhost:3000`](http://localhost:3000). |
26 | 26 |
|
27 |
| -`docs:build` builds a static Docz website in `.docz/dist`. |
| 27 | +`npm run docs:build` builds a static Docz website in `.docz/dist`. |
28 | 28 |
|
29 |
| -`docs:deploy` pushes the static Docz website to the `gh-pages` branch, so that it's available at [`https://evercoder.github.io/uiuiui`](`https://evercoder.github.io/uiuiui`). |
| 29 | +`npm run docs:deploy` pushes the static Docz website to the `gh-pages` branch, so that it's available at [`https://evercoder.github.io/uiuiui`](`https://evercoder.github.io/uiuiui`). |
0 commit comments