React ION

A collection of Styled Components for use with the ION Design System. For consistency in our components this library utilizes Styled System to add utility props to alter styling that falls in line with our design system.

This design system utilizes Storybook to preview and interact with different components.

View our Production Storybook

Getting Started

Prerequisites

• nvm: https://github.com/creationix/nvm#installation
• yarn: https://yarnpkg.com/lang/en/docs/install

NOTE: We use yarn because of the added security benefits as well as other features. Because yarn using yarn.lock and npm using package.lock we need to be consistent about using the same package tool within a project.

Installing

yarn install

Local Development

This project uses semantic-release and git-cz to manage our NPM releases. Make sure to install commitizen:

npm install -g commitizen

When running git commit you will be prompted with a CLI. The CLI will generate a formatted commit message that will determine the release of the next version.

git commit

To run the tests:

yarn test

To check TypeScript types:

yarn types:check

To check Linting (this will lint with JS and CSS):

yarn lint

To run all tests required to pass CI use:

yarn validate

To start the development Storybook:

yarn storybook

To update storyshots use:

yarn test -u

Production Build

To build code ready for production use:

yarn build

To start the production application use:

yarn start

Deployment

Changes merged into master are automatically deployed and released by our CI/CD pipeline. This done with Gitlab CI.

Components

COMING SOON - Look in our Storybook stories for examples

Contributing

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License -- see the LICENSE for details.