@onrewind/ui

The React implementation of our design system.

Geting started

Import the css file in your main file :

import '@onrewind/ui/lib/onrewind-ui.css';

Import the Tailwind presets in your tailwind.config.js:

module.exports = {
  // .....
  presets : [require('@onrewind/ui/origins.preset.js')]
  theme : {
    // .....
  }
}

How to run

Install dependencies

yarn install

Start Storybook on localhost:9009 by running the following command

yarn guide

How to release

1. Merge the pull request from Bitbucket into develop
2. Merge develop into master (git checkout master && git merge develop)
3. Push the master branch.
4. Jenkins will take over and will:
   • Add a release commit on master
     • Update the changelog
   • Tag the release
   • Push to NPM
5. You will receive a notification on the #design-system Slack channel on a successful deploy.
6. You need to rebase develop with the updated master branch:
   • git checkout master
   • git pull
   • git checkout develop
   • git rebase master
   • git push

Connect to Next.js apps locally

Follow the guide

Files architecture

See ARCHITECTURE.md