Overview

Mayflower is an enterprise design system specifically created for the state government of Massachusetts. It provides a set of core documentation and experimental component libraries for building websites and applications. Mayflower is licensed under the GNU General Public License v2.0.

Features

• Core Documentation: Access to the official documentation of the Mayflower design system, available at mayflower.digital.mass.gov/core.
• Experimental Component Libraries: Component libraries developed by Massachusetts Digital Service for building websites like Mass.gov, Search.mass.gov, and Massachusetts budget sites.
• Mayflower Patternlab GitHub Version: Access to the Mayflower Patternlab GitHub repository.
• Mayflower React npm Package: npm package for developing with Mayflower React.

Installation

To install the Mayflower theme, follow these steps:

1. Install Rush globally by running the following command:

npm install -g rush

2. Run the following command to install pnpm and each package’s dependencies on disk and symlink together all local packages that depend on one another:

rush install

3. To start developing with Mayflower React, run the following command:

rush start:react

4. To start developing with Mayflower Patternlab, run the following command:

rush start:patternlab

5. To start developing with Mayflower Site, navigate to the react package directory and build the local @massds/mayflower-react package by running the following command:

cd packages/react && rushx build

Then, start the Mayflower site with the following command:

rush start:site

Summary

Mayflower is an enterprise design system designed for the state government of Massachusetts. It offers core documentation, experimental component libraries, and packages for React development. The installation guide provides step-by-step instructions for setting up the theme and starting development.