@cmsgov/ds-healthcare-gov

HealthCare.gov Child Design System

>> View the full documentation site here <<

The HealthCare.gov Child Design System is a standalone design system, built on top of the CMS Design System (CMSDS), for use in healthcare.gov applications. It is a child of the CMS Design System in that it inherits all of the functionality of its parent while also adding its own features and customizations.

Usage

For documentation on installation and usage, please refer to our documentation site.

Contributing

This site-wide design system has a much smaller group of users than the core CMS Design System. It's up to us to make it useful for our apps. It is a place to share code and collaborate across teams. It is our collective source of truth for design. If you want to contribute but need help getting started, shout in the #hcgov-design-system channel on the CMS Slack or open up an issue on this repo.

Running locally

This project uses Yarn for package management. Yarn helps to ensure everyone is using the same package versions. Install Yarn, if you don't have it yet.

Getting started

1. yarn install
2. yarn start

Note: When you create a Git commit, any staged scripts will be automatically run through ESLint and Prettier. If the linter catches an error, your commit will fail. This is a feature, not a bug :)

Scripts

These scripts can all be run from the root level of the repo:

• yarn start
  • Starts local server running the documentation site
  • Regenerates documentation when files change
• yarn build
  • Compiles and processes all the code and assets and copies them to the dist directory so that they're ready for distribution and consumption as a package
• yarn test
  • Runs JS unit tests
• yarn test:e2e
  • Runs end to end tests
• yarn update-snapshots
  • Updates Jest snapshots
• yarn lint
  • Runs Prettier for formatting
  • Lints JS using ESLint
  • Lints Sass using stylelint
• yarn gh-pages
  • Builds the documentation site and publishes it to GitHub Pages
  • Note that it operates from your local version, so whatever version you have checked out will be built and deployed to GitHub Pages
  • See PUBLISHING.md for instructions
• yarn release
  • Builds a release and publishes to NPM
  • See PUBLISHING.md for instructions

Building on top of the CMS Design System

As a child design system to the CMS Design System, we need to know how the CMSDS and its tooling work. For more information on how to build off of the CMSDS, extend it, and customize it, check out the child design system example and its documentation.