@raspberrypifoundation/design-system-react v1.6.0

Design System React

Usage

Using npm:

npm install @raspberrypifoundation/design-system-react
npm run storybook

Using yarn:

yarn install @raspberrypifoundation/design-system-react
yarn storybook

Working with a local version of design-system-core

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.

1. Navigate to your local design-system-core repo create a global symbolic link.

npm link

2. In design-system-react remove the node_modules folder and install the application.

rm -rf node_modules && npm i

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.

npm link @raspberrypifoundation/design-system-core

Troubleshooting

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:

• 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.

• Ensure that you are running the npm link command in step 3 AFTER step 2. Doing these in the wrong order will not work.

Deployment

Create a new release:

• Update the changelog, package.json (then run npm i to update package-lock.json) and commit.
• Click 'Draft a new release'
• Type the version in the dropdown and click 'Create new tag'
• Add a title and some notes about what the release contains
• Click 'Publish release' (leave 'Set as latest release' checked) and a build will be kicked off
• Add new version to package.json in your app

Using Docker

TODO