Skip to content

Commit

Permalink
Update the README to include running storybook
Browse files Browse the repository at this point in the history
  • Loading branch information
Yolijn authored Feb 14, 2021
1 parent 94b93ee commit 024bf86
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@ This template contains all relevant linting rules used by the NL Design System r
It also contains the Storybook setup with two example components and two example general documentation page.
Feel free to add or modify those documentation pages and use the example components as an initial template to create your own storybook components.

## Storybook

### Run Storybook on your computer
1. Clone the repository
2. Use an editor like VS Code
3. In a terminal run `npm install`
4. Run storybook
a. In VS Code in the `terminal` tab click on `run Storybook`
b. In the Terminal run `npm run storybook`
5. Your main browser opens automatically with your local storybook

### Change the theme of your storybook to match your brand

In `.storybook/customTheme.js` the theme used by NL Design System can be found. By changing those properties one can style the storybook to match ones brand. Checkout [https://storybook.js.org/docs/react/configure/theming](https://storybook.js.org/docs/react/configure/theming) to learn more about all the possible configurations to brand this storybook.
Expand Down

0 comments on commit 024bf86

Please sign in to comment.