💅 Component based design system to power our interfaces

Why?

Design Systems Part I: Foundations

Pre-requisites

• Yarn
• Node >=10

This project uses JSDoc syntax to automatically generate docs and usage instructions within storybook so it's recommended to familiarise yourself with JSDoc syntax

Technologies

• React
• TypeScript
• emotion
• eslint
• babel
• storybook

Developing components

To start the watch server

yarn start

This should start a server on localhost:6006

When developing components they should be in their own named folder under ./components/NameOfComponent.

Linting

Automatically fix recommended lint errors:

yarn lint --fix

Or to see what eslint is about to change:

yarn lint --dry-run

Crystal by Dima Lagunov from the Noun Project