czb-ui

High level components for CZ Biohub. Based on CZI's Science Design System and Material UI v5.

To get started, visit the introduction documentation.

Develop

On the first time cloning this repo, run yarn build first.

Run storybook with live refresh: yarn dev from project root.

If there are any build errors, try running yarn build again as it may fix some issues.

Before making a PR

1. Run yarn changeset in the project's root directory.
2. Mark the packages that need to have their version bumped up.
   • Make sure to follow the SemVer Versioning spec
3. Answer the remaining questions.
4. Commit the new changeset into git.
5. Remember to push those changes into your branch before making a PR!

Publishing a version to npm

You will need to be on the czb-ui npm organization with 2FA enabled. Make sure you are also on the main branch.

1. Run yarn changeset version in the project's root directory. Note after running this command you should not make anymore commits after step 2.
2. Commit the changes the command made.
3. Run yarn build in the project's root directory.
4. Run yarn changeset publish in the project's root directory.
5. Run git push && git push --tags to push the remaining commits and tags made from the previous commands.

Pre-release version

Please do not follow these steps in the main branch.

1. Switch to the prerelease branch.
2. Make sure the changesets pre-release is configured. This can be checked by the mode and tag values in .changeset/pre.json.

   head .changeset/pre.json

   {
     "mode": "pre",
     "tag": "alpha",
     "initialVersions": {

   If .changeset/pre.json does not exist, pre-releases are not configured. Please see the changesets pre-releases documentation.
3. Merge main into the prerelease branch.
4. Run the regular steps under "Publishing a version to npm".

If you get warnings like this running yarn changeset version:

Package "docs" must depend on the current version of "@czb-ui/biohub-logos": "1.0.0-alpha.0" vs "*"

These can be ignored. Since the apps are built using whatever is in the monorepo, and are also not published to npm, they don't need to stick to a specific version.