Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
plugins/gatsby-pivotal-ui-styleguide
src
static
stylesheets
.cfignore
.eslintrc
README.md
Staticfile
babel.config.js
gatsby-browser.js
gatsby-config.js
gatsby-node.js
gatsby-ssr.js
manifest.yml
package.json
yarn.lock

README.md

Pivotal UI Styleguide

This is the styleguide and documentation for Pivotal UI, Pivotal's design system.

Contributing

We encourage and appreciate pull requests to improve the styleguide. All documentation and code examples are written in Markdown files that live in the docs directory.

All React components live in the src directory, and all CSS lives in the stylesheets directory.

Developing

The styleguide is a React app. To develop locally, you will need Node and Yarn installed.

Running Locally

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.

  1. Navigate to the styleguide directory
  2. yarn install to install Node dependencies
  3. yarn start to start the live-reloading development server on port 8080
  4. Navigate to localhost:8080 to view the styleguide

Changes to either the styleguide code or Pivotal UI code will now reload the dev server.

Testing Locally

  1. yarn test to run all the tests from the command line

Pushing

  1. ./push.sh to run the linter, run the tests, and push
You can’t perform that action at this time.