Pivotal UI Styleguide
This is the styleguide and documentation for Pivotal UI, Pivotal's design system.
We encourage and appreciate pull requests to improve the styleguide. All documentation and code examples are written in Markdown files that live in the
All React components live in the
src directory, and all CSS lives in the
The styleguide is built directly from the Pivotal UI source code, so you will need to clone both this repo and the Pivotal UI repo side-by-side on your computer.
- Navigate to the styleguide directory
yarn installto install Node dependencies
yarn startto start the live-reloading development server on port 8080
- Navigate to
localhost:8080to view the styleguide
Changes to either the styleguide code or Pivotal UI code will now reload the dev server.
yarn testto run all the tests from the command line
./push.shto run the linter, run the tests, and push