REI Cedar Style Framework!

Welcome to REI's style framework! The overall goals of this project are to provide a common scaffolding for UI elements, and a set of themes that build on this scaffolding. We started this project in 2015 as a fork of Bootstrap. The project has evolved into what it is today, and will continue to grow to fit our expanding needs. Feel free to watch the Cedar grow and learn from what we are doing, or jump in and provide some recommendations.

Using Cedar

See the Cedar docs for usage instructions.

Getting Started

Install

Clone the project.

pnpm install

Run

pnpm run dev

Runs locally for development. Has hot reloading, and other nice things related to development.

Testing

Code Tests

pnpm run unit

Runs unit tests.

pnpm run watch

Runs unit tests in watch mode. This also allows you to inspect snapshot discrepancies and regenerate the snapshots if appropriate.

pnpm run test:playwright

Runs Playwright end-to-end tests and Axe a11y tests.

pnpm run test

Runs both unit and e2e/accessibility tests.

Publishing Prerelease Components

pnpm run prerelease

Publishes package to npm with a prerelease tag. You must increment the component's version manually prior to publishing. --dry-run flag will run the prerelease process without publishing to npm.

Commits

This project is Commitizen friendly. To use Commitizen, run pnpm exec git-cz or pnpm exec cz. When creating a pull request run git cz rather than git commit and follow the prompts.

This project's changelogs are generated by the release process.

Developer demo

The main documentation site for Cedar is our separate Cedar docs website. With that in mind, we also have a playground for developing components and sharing ideas with others and within our team. The Cedar team produces this Storybook through GitHub Pages that can be accessed at https://rei.github.io/rei-cedar/.