Skip to content

Commit

Permalink
Talk about the scope/goals of the design system
Browse files Browse the repository at this point in the history
  • Loading branch information
domyen authored Jun 17, 2019
1 parent b0f51dc commit b139201
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,40 @@
[![NPM](https://img.shields.io/npm/v/@storybook/design-system.svg)](https://www.npmjs.com/package/@storybook/design-system) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Used by
- [Storybook homepage](https://storybook.js.org/)
- [LearnStorybook.com](https://www.learnstorybook.com/)
- [ChromaticQA.com](https://www.chromaticqa.com/)

Note: this design system is not used in Storybook's UI. The stack is different and theming requirements of Storybook add complexity beyond the scope of this project. However, Storybook's visual design is identical to what's here.

## Tech stack
Building components
- πŸ“š [Storybook](https://storybook.js.org) for UI component development and [auto-generated docs](https://medium.com/storybookjs/storybook-docs-sneak-peak-5be78445094a)
- πŸ’… [Styled-components](https://www.styled-components.com/) for component-scoped styling
- βš›οΈ [React](https://reactjs.org/) declarative component-centric UI

Maintaining the system
- πŸ“¦ [NPM](https://www.npmjs.com/) for [packaging and distribution](https://blog.hichroma.com/how-packaging-makes-it-dead-simple-to-share-ui-components-29912593539d)
- βœ… [Chromatic](https://www.chromaticqa.com/) to prevent UI bugs in components (by Storybook maintainers)
- πŸš₯ [CircleCI](https://circleci.com/) Continuous integration

## Why
The Storybook design system codifies existing UI components into a central, well-maintained repository. It is built to address having to paste the same components into multiple projects again and again. This simplifies building UI's with Storybook's design patterns.

#### What we're doing
- Build and maintain a design system in the open
- Share UI components between multiple apps
- Dogfood upcoming Storybook features
- Welcome contributors of all levels and backgrounds


#### What we're not doing
- Rewrite all new components from scratch
- Overhaul the visual design of components
- Typescript (the consumer apps don't use it)
- Compete with more general design systems like ANT or Material.

## Install

```bash
Expand Down

0 comments on commit b139201

Please sign in to comment.