Package | Version |
---|---|
@clarityhub/unity-core | |
@clarityhub/unity-email | |
@clarityhub/unity-forms | |
@clarityhub/unity-marketing | |
@clarityhub/unity-web |
See our documentation on how to use the Unity Design System.
- Install npm:
npm i
- Install lerna
- Run
npm run bootstrap
- Build packages -
npm run build
You can now develop on each package. Run npm run docz:dev
to generate the Design System docs.
If you need to run snapshots to update them or generate new ones, you can run the following command:
npm run test:watch -- --scope=@clarityhub/unity-web
The unity-email package has a special build that you can run to generate example HTML files:
npm run build
npm run emails:watch
npm run emails:run
- Open the
/lib
folder - You can open any generated .html file to preview what emails will look like
Run npm run release
to lint, run tests, and publish the packages (if you have permission).
Run npm run deploy
to build the Docz site and deploy to gh-pages (if you have permission).