Stardust

This Repo contains all sources used to build a TILLER design system library.

Install

You can install Stardust using either of the methods below.

For YARN users:

  $ yarn add @tillersystems/stardust

For NPM users:

  $ npm install @tillersystems/stardust

Explore

We have a few examples on Storybook, you can see them by running:

  $ yarn storybook

  // or

  $ npm run storybook

Contribute

Getting started

To install the project, you should follow the Installation guide.

After that, you should be able to start the application with:

yarn start

Directory Structure

TODO

Coding Style

ESLINT

To run ESLint you could run

yarn lint
Use atom with this plugin : https://github.com/AtomLinter/linter-eslint. In settings make sure "Use global ESLint installation is unchecked to be sure that you are using project eslint configuration. Plus, don't hesitate to check fix errors on save !
You can override airbnb rules, add plugins or settings by editting .eslintrc file.
Discuss with team to improve/remove rules

Don't prefix your css rules (-webkit, -moz, ...). It will be done automatically.

Testing

Unit Tests

The project uses Jest to run unit tests.

To run the tests in the project, just simply run:

yarn test

Dependencies

Each dependency should be installed with yarn add {dependency-name} command. Each dev dependency should be installed with yarn add {dependency-name} -D command.

Thanks

tillersystems/Stardust