✨ Radiance UI

Curology's React based component library

Storybook

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.

Contributing

To contribute to Radiance UI, please create a PR with the following in the appropriate places:

• Source code for the component
• Tests
• A storybook story

Tests

Tests can be run with yarn run test. Radiance uses Jest + @testing-library.

Local Development Setup

If you want to test out your changes with another repo that uses Radiance, we recommend using the link feature with npm or yarn.

Documentation

Documentation around usage can be found in the respective Docs page of every component on 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).

You'll have to log into npm (https://www.npmjs.com/login) using the credentials found in the Tech - Product Engineering 1Password vault. Use the recovery codes when prompted for 2fa OTP. Each code can only be used once. Regen codes when done.

1. Once approved in Github and Chromatic (if applicable), merge your PR(s) into master.
2. Check out the master branch, fetch and pull.
3. Commit an update to the CHANGELOG.md file with details.
4. Run npm login and use the creds in the Tech - Product Engineering 1Password vault.
5. Run yarn run publish-package to build the bundled files and publish to NPM.
6. Push changes made to package.json to remote repository
7. On GitHub, tag a release with the proper version and details. You can do that here.

Thanks

Thanks to Chromatic for providing the visual testing platform that helps us review UI changes and catch visual regressions!