Skip to content

Commit 4968342

Browse files
kylebuch8mwcz
authored andcommitted
Pr/143 (#144)
* doc updated to reflect command new instead of dev * adding a few more scripts Changed Workflow to Scripts since that does a better job of describing the list of commands. Reverted the component development section to say npm run dev since npm run new would create a new component.
1 parent 00cb4d4 commit 4968342

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,27 +14,29 @@ $ npm rebuild node-sass # this may be necessary
1414
$ npm start
1515
```
1616

17-
## Workflow
17+
## Scripts
1818

19-
- `$ npm start`
19+
- `$ npm start`
2020
- Launch a demo server. This should be continuously running as you develop.
21-
- `$ npm run dev`
22-
- Build a component.
23-
- `$ npm test`
24-
- Run tests on ALL rhelements.
25-
- `$ npm run build`
26-
- Run build on ALL rhelements.
27-
- `$ npm run bootstrap`
21+
- `$ npm run new`
22+
- Create a new component.
23+
- `$ npm test`
24+
- Run tests on ALL RHElements.
25+
- `$ npm run build`
26+
- Run build on ALL RHElements.
27+
- `$ npm run bootstrap`
2828
- Update ALL rhelements' dependencies and interlink them with [lerna bootstrap][lerna-bs].
2929
- `$ npm run storybook`
30-
- Run storybook
30+
- Run storybook
31+
- `$ npm run build-storybook`
32+
- Build storybook for deployment
3133

3234
[lerna]: https://github.com/lerna/lerna
3335
[lerna-bs]: https://github.com/lerna/lerna#bootstrap
3436

3537
## Component development
3638

37-
Because this is a monorepo, each component will need to be independently built in order to actively work on and preview the changes. Every component has its own Gulp file and NPM script.
39+
Because this is a monorepo, each component will need to be independently built in order to actively work on and preview the changes. Every component has its own Gulp file and NPM script.
3840

3941
While still running `npm start` in one terminal window (which runs the local server), you will need to open another terminal window, drill into the directory of the component you'd like to work on, and execute the `npm run dev` command. This command will use gulp tasks to watch the files within that component directory and will automatically re-run the build command and refresh the browser when you make changes to the component.
4042

0 commit comments

Comments
 (0)