Skip to content

Latest commit

 

History

History
88 lines (58 loc) · 3.78 KB

README.md

File metadata and controls

88 lines (58 loc) · 3.78 KB
Raw

Larva

This is the mono-repo for PMC's design system, Larva. It contains Larva features that should be available across platforms.

Usage

Consult each package's README for a description and directions for use. Consult the How-To Guides in Confluence for details on using Larva in consuming projects. When upgrading a consuming project, consult UPGRADING.md for breaking changes and other important information.

Local Development Setup

Clone this repository then, from the root, run the following commands:

nvm use
sh scripts/install-dependencies.sh

These will setup the mono-repo and install dependencies for each of the packages. This will take a few moments.

If you are updating dependencies or debugging version conflicts, there is an addition script to use that will wipe the node_modules and package-lock.jsons for a fresh installation. Note: this script will also run the asset building script, so pay attention to diffs.

sh scripts/refresh-dependencies.sh

Linking Larva for Local Development

When working with Larva locally, you'll likely want to test your changes on a Larva project.

Using npm link, we can point your local project's Larva packages to your local Larva monorepo.

  1. From within this repo, run npm run link-all to link the Larva, Patterns, CSS, and JS packages.
  2. From within your project, run npx @penskemediacorp/larva link-all.
  3. From within your project, run a full build with npx @penskemediacorp/larva prod.

Viewing Larva Patterns

To view and develop Larva patterns, run the following command after the above installation setup:

npm run larva

This will open a development server at localhost:3000. You can contribute to patterns in the packages/larva-patterns, and see the updates reflected here.

Changing the Default Port

To modify the port Larva runs on, you can use NODE_PORT before your npm run larva command,

 NODE_PORT=8080 npm run larva

Running Visual Regression Tests

First, make sure the Larva server is running from the root of this repo. To run the Larva server:

npm run larva

Open a new command window and again, from the root, manually run visual regression tests with the following command:

npm run backstop -- test

If the tests contain changes that are intended, approve the new screenshots with the following command:

npm run backstop -- approve

To manually run visual regression tests, use the following command:

npm run backstop -- test

If the tests contain changes that are correct, you can generate new reference screenshots. To do this, you should visit the Github repo and run the workflow action to update the visual regression tests. This will create a new branch with the suffix --update-backstop-reference appended to your current branch name. You should then make a pull request into your current branch from that branch after reviewing the updated screenshots and then merge it into your branch with feature changes so it passes the automated regression tests.

Contributing To and Building Assets

The core Larva repo uses Larva tools to build patterns. Some packages contain their own build steps, such as larva-css and larva-tokens. The flow is as follows:

  1. Larva CSS and Larva Tokens should be compiled in their respective packages with npm run build.
  2. Then run npm run prod from the root of this repo to pulls everything together into a larva.css and to compile the default JS source files, and copy the build files into package/larva so they are available to consuming projects