✨ Radiance UI
Curology's React based component library
Radiance UI has a built in storybook. Every time a new commit is made to master, it is automatically deployed to https://radiance-ui.curology.com.
To run Storybook locally, use
yarn run storybook.
To contribute to Radiance UI, please create a PR with the following in the appropriate places:
- Source code for the component
- A storybook story
Tests can be run with
yarn run test. Radiance uses Jest + Enzyme.
Local Development Setup
Documentation around usage, you can also see it with knobs at: https://radiance-ui.curology.com
Publishing to NPM
You'll need access to publish to NPM so this part only applies to a few people (mostly within the Curology organization). Once approved, merge your PR(s) into master and follow these steps:
- Pull latest master and check out the master branch.
- Commit an update to the CHANGELOG.md file with details.
yarn run publish-packageto build the bundled files and publish to NPM.
- Push changes made to
package.jsonto remote repository
- On GitHub, tag a release with the proper version and details. You can do that here.