@raspberrypifoundation/design-system-react 1.1.16 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -2
- package/dist/cjs/bundle.js +262 -16
- package/dist/esm/bundle.js +257 -17
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -3,10 +3,12 @@
|
|
|
3
3
|
## Usage
|
|
4
4
|
|
|
5
5
|
Using `npm`:
|
|
6
|
+
|
|
6
7
|
```bash
|
|
7
8
|
npm install @raspberrypifoundation/design-system-react
|
|
8
9
|
npm run storybook
|
|
9
10
|
```
|
|
11
|
+
|
|
10
12
|
Using `yarn`:
|
|
11
13
|
|
|
12
14
|
```bash
|
|
@@ -14,7 +16,37 @@ yarn install @raspberrypifoundation/design-system-react
|
|
|
14
16
|
yarn storybook
|
|
15
17
|
```
|
|
16
18
|
|
|
17
|
-
###
|
|
19
|
+
### Working with a local version of [design-system-core](https://github.com/RaspberryPiFoundation/design-system-core)
|
|
20
|
+
|
|
21
|
+
Sometimes you may want to work on `design-system-core` and `design-system-react` at the same time. You can do this by working with your local version of core using `npm link`.
|
|
22
|
+
|
|
23
|
+
1. Navigate to your local `design-system-core` repo create a global symbolic link.
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
npm link
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
2. In `design-system-react` remove the node_modules folder and install the application.
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
rm -rf node_modules && npm i
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
3. Navigate to your local `design-system-react` repo and tell the application to use the global symbolic link. You should notice "changed 1 package" in the response.
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
npm link @raspberrypifoundation/design-system-core
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
#### Troubleshooting
|
|
42
|
+
|
|
43
|
+
If you are experiencing issues and believe design-system-react is not using your local version of design-system-core, or if you are running into issues running `npm link`, try the following:
|
|
44
|
+
|
|
45
|
+
- Check that `design-system-react` and `design-system-core` are both using the same `nodejs` version in `.tool_versions`. If they are not, update the node version(s) in `.tool_versions` locally and retry the steps above. If this was the issues / the `nodejs` versions are not the same, consider creating a PR to bring them in-line.
|
|
46
|
+
|
|
47
|
+
- Ensure that you are running the `npm link` command in step 3 AFTER step 2. Doing these in the wrong order will not work.
|
|
48
|
+
|
|
49
|
+
## Deployment
|
|
18
50
|
|
|
19
51
|
Create a new [release](https://github.com/RaspberryPiFoundation/design-system-react/releases):
|
|
20
52
|
|
|
@@ -25,6 +57,6 @@ Create a new [release](https://github.com/RaspberryPiFoundation/design-system-re
|
|
|
25
57
|
- Click 'Publish release' (leave 'Set as latest release' checked) and a build will be kicked off
|
|
26
58
|
- Add new version to `package.json` in your app
|
|
27
59
|
|
|
28
|
-
|
|
60
|
+
## Using Docker
|
|
29
61
|
|
|
30
62
|
TODO
|