This repository provides assets, styling libraries, and component libraries as part of the St. Jude Cloud design system. The table below shows the packages contained within and their respective purposes. To get started, navigate to your directory of interest listed below.
| Package | Folder | Published to NPM | Description |
|---|---|---|---|
@stjudecloud/assets |
assets/ |
YES | Contains all, non-minified assets used on the St. Jude Cloud project. |
@stjudecloud/theme-bootstrap |
themes/bootstrap |
YES | Both production-ready and development files for the Bootstrap St. Jude Cloud theme. |
@stjudecloud/ui-react |
packages/react |
YES | Production-ready React component library for the St. Jude Cloud design system. |
@stjudecloud/design.stjude.cloud |
fractal/ |
NO | Fractal source code for rendering https://design.stjude.cloud. |
While this repo features several packages that you can pull into a project independently, it should be noted that there are some interdependencies between the repo's packages which could affect the order in which you make your changes.
For example, if you want to add an app to the omnibar, you should make changes and publish the image to the assets package to then use it in rendering the DSM or creating a component. The same idea applies if you need to make styling changes in the Bootstrap package that you would then use in a framework component. Refer to the table below for guidance on how these packages affect one another.
| Package | St. Jude Cloud Dependencies |
|---|---|
@stjudecloud/assets |
None |
@stjudecloud/theme-bootstrap |
None |
@stjudecloud/ui-react |
@stjudecloud/assets & @stjudecloud/theme-bootstrap |
@stjudecloud/design.stjude.cloud |
@stjudecloud/assets & @stjudecloud/theme-bootstrap |