RAC Style Library and Guide

Style library and guide for Rockefeller Archive Center websites.

Getting started

Install dependencies using yarn install.

This project uses Dart Sass. Compile SCSS stylesheets to CSS using:

yarn compile

Storybook

We use Storybook to help us develop styles and documentation for components and provide and interactive UI. To run Storybook locally, run yarn storybook. Storybook should open in a new browser tab.

Component documentation sources

We used multiple existing design system documentation and style guides to help document and articulate best practices for our own components, including the GOV.UK Design System, Atlassian Design System, Carbon, and A11y Style Guide.

Tests

Unit tests have been added to ensure that mixin output and Sass functions are correct. To run tests:

yarn test

Unit tests are set up to run in the CI pipeline. The build will fail if the tests do not pass.

Linting

This project uses stylelint, which can be configured using the .stylelintrc.json file located in the root of this repository. To run linting:

yarn lint

To autofix any reported issues (manual cleanup may still be required):

yarn lint-fix

Linting is set up to run in the CI pipeline. The build will fail if linting does not pass.

Attribution

The /stylesheets structure and README files are adapted from sass-biolerplate, created by Kitty Giraudel.

License

This code is released under an MIT License.