cfarm / design-system

WIP

CFPB's Design System

The documentation website is in docs/. The code for Capital Framework, our UI library, is in src/.

Getting started with our docs

Clone or fork the repo, then install dependencies:

git clone https://github.com/test-things/design-system.git
cd design-system/docs
yarn

To run a local copy of Netlify CMS that will open PRs against this GitHub repository:

yarn start

Notes:

• Visit http://localhost:4000/design-system/ to view the site.
• Visit http://localhost:4000/design-system/admin to log into the CMS. Note: The CMS talks to GitHub.com so editing a page in the CMS will open a pull request.
• The OAuth app is hosted on glitch.
• Webpack and Jekyll will watch your JS and HTML and recompile when changed.
• The website is in docs/.
• Capital Framework has been copied into src/.
• Custom Netlify CMS widgets are in docs/admin/src/.
• Jekyll templates are in docs/_layouts/.

Getting started with Capital Framework

We're in the process of migrating Capital Framework to this repository. For now, it still lives at cfpb/capital-framework. Stay tuned.