@cmsgov/ds-healthcare-gov

A design system for HealthCare.gov products

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
69Jun 17, 2021Oct 26, 2020Minified + gzip package size for @cmsgov/ds-healthcare-gov in KB

Readme

HealthCare.gov Design System

npm

>> View the full documentation site here <<

The HealthCare.gov Design System contains shared design and front-end development resources for Healthcare.gov applications, and is built on top of the CMS Design System (CMSDS). As a child design system, it inherits base styles, components, and guidance from the CMS Design System, 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
  • 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, the Healthcare.gov Design System shares the same tooling and organization as the CMSDS. For more information on how to extend and customize SASS, JS, and documentation, check out the child design system example and its documentation.

Who’s using the Healthcare.gov design system

The design system is currently being applied to some pages on HealthCare.gov and project teams are actively working to apply the design system consistently across all of HealthCare.gov.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.