Khan / wonder-blocks

React components for Wonder Blocks design system.

Home Page:https://khan.github.io/wonder-blocks

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Wonder Blocks

Release codecov

The Khan Academy Wonder Blocks design system. This is work-in-progress and a lot of things are still in motion.

More information: https://khan.github.io/wonder-blocks/

Getting started

Prerequisites

Installation

To install Wonder Blocks, you need to run the following commands:

yarn install

Installs project dependencies

yarn start

Runs the docs in dev mode

Now you can open http://localhost:6061 to view the docs. This page will automatically update as you make changes to components.

Contributing

Note for external contributors: We are not accepting external contributions at this time. We are working to make this happen in the future, and we will let you know when this is possible!

For a more detailed explanation about how to develop Wonder Blocks components, please refer to the internal documentation

Please note – before contributing ensure that any design changes you are wanting to make are reflected in the Wonder Blocks project in Figma.

Thanks

Thanks to Chromatic for providing the visual testing platform that helps us catch unexpected changes on time.

About

React components for Wonder Blocks design system.

https://khan.github.io/wonder-blocks

License:MIT License


Languages

Language:TypeScript 91.7%Language:MDX 7.0%Language:JavaScript 0.8%Language:CSS 0.3%Language:Shell 0.1%Language:HTML 0.1%Language:Vim Script 0.0%