https://github.com/czbiohub-sf/czb-ui
CZ Biohub's higher level components made with CZI's Science Design System Component Library.
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.8%) to scientific vocabulary
Last synced: 11 months ago
·
JSON representation
Repository
CZ Biohub's higher level components made with CZI's Science Design System Component Library.
Basic Info
- Host: GitHub
- Owner: czbiohub-sf
- License: bsd-3-clause
- Language: TypeScript
- Default Branch: main
- Homepage: https://czb-ui-docs.vercel.app
- Size: 9.5 MB
Statistics
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 13
- Releases: 0
Created over 4 years ago
· Last pushed almost 2 years ago
Metadata Files
Readme
License
README.md
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
- Run
yarn changesetin the project's root directory. - Mark the packages that need to have their version bumped up.
- Make sure to follow the SemVer Versioning spec
- Answer the remaining questions.
- Commit the new changeset into git.
- 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.
- Run
yarn changeset versionin the project's root directory. Note after running this command you should not make anymore commits after step 2. - Commit the changes the command made.
- Run
yarn buildin the project's root directory. - Run
yarn changeset publishin the project's root directory. - Run
git push && git push --tagsto push the remaining commits and tags made from the previous commands.
Pre-release version
Please do not follow these steps in the main branch.
- Switch to the
prereleasebranch. - Make sure the changesets pre-release is configured. This can be checked by the
modeandtagvalues in.changeset/pre.json.sh head .changeset/pre.jsonjson { "mode": "pre", "tag": "alpha", "initialVersions": {If.changeset/pre.jsondoes not exist, pre-releases are not configured. Please see the changesets pre-releases documentation. - Merge
maininto theprereleasebranch. - 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.
Owner
- Name: Chan Zuckerberg Biohub San Francisco
- Login: czbiohub-sf
- Kind: organization
- Location: San Francisco
- Website: https://www.czbiohub.org/sf/
- Repositories: 1
- Profile: https://github.com/czbiohub-sf
GitHub Events
Total
- Issues event: 1
- Member event: 1
- Issue comment event: 1
- Push event: 22
- Pull request event: 2
- Create event: 5
Last Year
- Issues event: 1
- Member event: 1
- Issue comment event: 1
- Push event: 22
- Pull request event: 2
- Create event: 5
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 1
- Total pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 1
- Total pull request authors: 1
- Average comments per issue: 0.0
- Average comments per pull request: 2.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 0.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- kyleawayan (25)
- leoisl (1)
Pull Request Authors
- kyleawayan (19)
Top Labels
Issue Labels
Pull Request Labels
bug (1)
Dependencies
package.json
npm
- prettier ^2.5.1 development
- turbo latest development
- @changesets/cli ^2.23.1
packages/biohub-logos/package.json
npm
- @mui/material ^5.8.5 development
- @rollup/plugin-typescript ^8.3.2 development
- @types/react ^17.0.37 development
- @types/react-dom ^17.0.11 development
- config * development
- rollup ^2.70.2 development
- rollup-plugin-delete ^2.0.0 development
- tsconfig * development
- typescript ^4.5.3 development
packages/config/package.json
npm
- eslint-config-next ^12.0.8
- eslint-config-prettier ^8.3.0
- eslint-plugin-react 7.28.0
packages/core/package.json
npm
- @emotion/css ^11.9.0 development
- @emotion/react ^11.9.3 development
- @emotion/styled ^11.9.3 development
- @mui/base ^5.0.0-alpha.90 development
- @mui/icons-material ^5.8.4 development
- @mui/lab ^5.0.0-alpha.91 development
- @mui/material ^5.9.1 development
- @rollup/plugin-typescript ^8.3.2 development
- @types/react ^17.0.37 development
- @types/react-dom ^17.0.11 development
- @types/uuid ^8.3.4 development
- config * development
- czifui ^7.0.0 development
- react ^18.2.0 development
- react-dom ^18.2.0 development
- rollup ^2.70.2 development
- rollup-plugin-delete ^2.0.0 development
- tsconfig * development
- typescript ^4.5.3 development
- hamburger-react ^2.5.0
- uuid ^8.3.2
yarn.lock
npm
- 2231 dependencies
.github/workflows/changeset.yml
actions
- actions/checkout v3 composite
- actions/setup-node v3 composite
.github/workflows/ci.yml
actions
- actions/checkout v3 composite
- actions/setup-node v3 composite
apps/czb-ui-storybook/package.json
npm
- @storybook/addon-essentials ^7.0.6 development
- @storybook/addon-interactions ^7.0.6 development
- @storybook/addon-links ^7.0.6 development
- @storybook/blocks ^7.0.6 development
- @storybook/react ^7.0.6 development
- @storybook/react-vite ^7.0.6 development
- @storybook/testing-library ^0.0.14-next.2 development
- @types/react ^18.0.28 development
- @types/react-dom ^18.0.11 development
- @typescript-eslint/eslint-plugin ^5.57.1 development
- @typescript-eslint/parser ^5.57.1 development
- @vitejs/plugin-react ^4.0.0-beta.0 development
- eslint ^8.38.0 development
- eslint-plugin-react-hooks ^4.6.0 development
- eslint-plugin-react-refresh ^0.3.4 development
- eslint-plugin-storybook ^0.6.11 development
- prop-types ^15.8.1 development
- storybook ^7.0.6 development
- typescript ^5.0.2 development
- vite ^4.3.0 development
- @czb-ui/biohub-logos *
- @czb-ui/core *
- @czb-ui/forms *
- @emotion/css ^11.9.0
- @emotion/react ^11.9.3
- @emotion/styled ^11.9.3
- @fontsource/barlow ^4.5.9
- @fontsource/hanken-grotesk ^4.5.2
- @fontsource/lato ^4.5.10
- @fontsource/stix-two-text ^4.5.16
- @mui/base ^5.0.0-alpha.90
- @mui/icons-material ^5.8.4
- @mui/lab ^5.0.0-alpha.91
- @mui/material ^5.9.1
- react ^18.2.0
- react-dom ^18.2.0
apps/docs/package.json
npm
- @czb-ui/biohub-logos *
- @czb-ui/core *
- @czb-ui/tinacms *
- @emotion/css ^11.9.0
- @emotion/react ^11.9.3
- @emotion/styled ^11.9.3
- @fontsource/barlow ^4.5.9
- @fontsource/hanken-grotesk ^4.5.2
- @fontsource/lato ^4.5.10
- @fontsource/stix-two-text ^4.5.16
- @mui/base ^5.0.0-alpha.90
- @mui/icons-material ^5.8.4
- @mui/lab ^5.0.0-alpha.91
- @mui/material ^5.9.1
- czifui ^14.4.0
- next ^14.1.1
- react ^18.2.0
- react-dom ^18.2.0
- react-is ^18.2.0
- styled-components ^5.1.3
- tinacms ^1.5.2
packages/forms/package.json
npm
- @rjsf/core ^5.2.1
- @rjsf/mui ^5.2.1
- @rjsf/utils ^5.2.1
- @rjsf/validator-ajv6 ^5.2.1
packages/tinacms/package.json
npm
packages/tsconfig/package.json
npm
packages/viz/package.json
npm
- @loaders.gl/core ^3.4.1
- @loaders.gl/images ^3.4.1
- deck.gl ^8.9.1