Skip to content
This repository has been archived by the owner on Jun 26, 2018. It is now read-only.

Latest commit

 

History

History
16 lines (14 loc) · 1.45 KB

demo-install.md

File metadata and controls

16 lines (14 loc) · 1.45 KB
Raw

Demo Install

Follow these steps to get up and running to demo or test Mayflower. Developers should see our Contribute docs for directions on how to set up your repo for development and contribution purposes.

  1. Clone this repo git clone git@github.com:massgov/mayflower.git
  2. Move into the styleguide directory cd mayflower/styleguide
  3. Generate pattern lab default files php core/console --generate
  4. Install npm dependencies npm install
  5. Run gulp
  6. Browse to http://localhost:3000/ (or port shown in gulp output if you've configured it differently)
  7. Take a look through Mayflower!
    • You can use the menu to look at whole page layouts (pages), templates, components (organisms and molecules), child elements (molecules and atoms), and some nuts and bolts (base).
    • You can emulate different device sizes by using the size buttons at the top right of the menu bar (S M L FULL RANDOM DISCO).
    • You can learn about patterns by clicking the top right COG icon, then selecting "Show Pattern Info" from the drop down.
  8. When you're done looking, type CTRL + C from your active terminal session to kill the gulp task. You can always run gulp again from the mayflower/styleguide directory to get it back up and running.
  9. We're constantly working to add new features, so if you want to make sure you have the latest and greatest remember to run git pull before you run gulp!