Design system prototype.
This is not production code. It's a playground for prototyping the technologies and architectural details for the Benchmark component library / design system.
# clone repo
$ git clone https://github.com/NAEPDEV/benchmark.git
$ cd benchmark
# install dependencies
$ yarn install
# Runs the "bootstrap" script defined in package.json.
# The script links together all the packages in the monorepo.
# This allows the "docs" package to use a live reference to the
# components from the main "benchmark" package.
$ yarn run bootstrap
Storybook is a workshop environment that is used to render the components in isolation. It is used to help develop and review the components from the main benchmark package.
# storybook
$ cd packages/storybook
$ yarn start
The docs package is a gatsby site which documents the design system. Throughout the documentation it renders live examples of the benchmark components. The pages in the site itself are built with the benchmark components with a documentation friendly theme applied.
# docs
$ cd packages/docs
$ yarn start
Playroom is a zero-install code-oriented design environment, built into a standalone bundle that can be deployed alongside benchmark's design system documentation.
# playroom
$ cd packages/playroom
$ yarn start
MIT