@ukhomeoffice/cms-react-components
v1.0.0
Published
[![Build and test](https://github.com/UKHomeOffice/cop-react-design-system/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/UKHomeOffice/cop-react-design-system/actions/workflows/build-and-test.yml) [![React publish to NPM](https://gith
Downloads
5
Keywords
Readme
Getting Started with Create React App
This project was bootstrapped with Create React App.
Available Scripts
In the project directory, you can run:
yarn storybook
Runs the app in the development mode.
Open http://localhost:6006 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
yarn test
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
yarn compile
Builds the components for production to the dist
folder.
It correctly bundles React components in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your components are ready to be deployed!
See the section about compile for more information.
yarn deploy
Runs both yarn build-storybook
and yarn deploy-storybook
in one step. This command is to be run after any changes have been made to components and merged into main for the public storybook to reflect these new changes.
yarn build-storybook
Builds the storybook files ending in .stories.mdx
to static HTML, CSS & JS files located in storybook-static
folder.
yarn deploy-storybook
Deploys the storybook build from the previous step to GitHub Pages. The storybook is deployed to special branch called gh-pages
.
The changes will be publicly available on Cop React Components Storybook
Learn More
You can learn more in the Introduction to Storybook for React.
To learn React, check out the React documentation.
Analyzing the Bundle Size
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
Advanced Babel Configuration
This section has moved here: https://babeljs.io/docs/en/usage/#configuration
To do
- [ ] How to deploy
Using the Service
Versioning
For versioning this project uses SemVer.
Authors
This project is authored by the Home Office.
License
This project is licensed under the MIT license. For details please see License.
This project contains public sector information licensed under the Open Government Licence v3.0. (http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/)