Mayflower

Mayflower is the enterprise design system for the Commonwealth of Massachusetts.

Getting Started

Setting up your environment

In order to run Mayflower locally, you need to have some things installed and set up on your machine. Follow the steps in setting up your machine.

Demo Install

• Follow the steps in Demo Install to get a copy of the project up and running on your local machine for demo and testing purposes.

Contribute

Please follow the steps in Contributing docs to set up your fork and repo for development and contribution purposes.

Deployment

Developer Deployment

Every time a branch passes CircleCI it will deploy the code to a the following URL http://mayflower.digital.mass.gov/b/<branch name>/index.html which will allow the developer to share the URL with reviewers to test their code.

Production Deployment

Mayflower release managers with the necessary repo permissions can see Release docs for steps on deploying code to production (i.e. do a release).

Generating assets

This project comes with gulp tasks to build Mayflower's static assets (html, css, js, + images) without serving them locally. See the gulp-readme for more information.

Mayflower Artifacts

Some Mass Digital Services projects (i.e. massgov/mass) use twig templates in addition to the static assets (html, css, js, image) from Mayflower. To establish that dependency, those projects point their dependency manager (i.e. composer) to the Mayflower Artifacts repository, which is a collection of Mayflower build artifacts with both twig and static assets. Learn more about Mayflower Artifacts in the massgov/openmass docs.

Built With

• Pattern Lab 2 (PHP) - The pattern framework / static site generator
• Twig - The templating language
• TwigJS - For clientside rendering of twig templates (see ajaxPattern)

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Learn about how Mayflower versions work in our Semantic Versioning docs.

License

This project is licensed under the is licensed under the GNU General Public License v2.0 - see the LICENSE.txt file for details.

Acknowledgments

• Atomic Design methodology by Brad Frost
• This awesome README template by @PurpleBooth