UNPKG

@rws-aoa/react-library

Version:

RWS AOA Design System

RWS-NL/aoa-design-system

43 lines (29 loc) • 1.4 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# RWS AOA Design System Welcome to our main library! This library contains components built with React and our Design System built with [Storybook](https://storybook.js.org/docs/react/get-started/why-storybook). ## Getting Started If this is the first time you are cloning and opening this library, start by installing all dependencies by running: ```bash yarn ``` You can build your components in React and view them in Storybook. Start Storybook by running: ```bash yarn storybook ``` You can write tests for components using the play function of stories. To run the tests, first start Storybook, then start the test-runner with: ```bash yarn test ``` This command automatically generates a code coverage report which will be shown in the terminal, and can also be found in the coverage folder. ## Using components More information on how to use the components from this design system can be found by running Storybook. In the menu on the lefthand side you will find a page called `Getting Started`. There you will find all the information you need regarding installing the library & importing, creating and using components. ## Making changes to components More information on how to contribute changes to the design system can be found by running Storybook. In the menu on the lefthand side you will find a page called `Contribute`. There you will find the information you need.