@olist/ui-commons

olist commons ui

UI-commons is a library of components used in applications developed by olist.

Installing / Getting started

  yarn add @olist/ui-commons

After that you'll be able to import it in your project and use the components and helpers.

  import { createForm } from '@olist/ui-commons/utils';

Developing

Built With

It was built on top of React 16.

Prerequisites

• Node version >= 8.9.0 <12.0.0.
• Npm version >= 5.5.1.
• It's fairly recommended using yarn for packages management.

Setting up Dev

Ok, you're looking forward to contributing, so follow the instructions.

If you're here, you already have access to the repository, haven't you? So, just clone the project and install the dependencies.

git clone [e-mail]:olist/olist-ui-commons.git
cd olist-ui-commons/
yarn
yarn dev

If everything's ok with your environment, all dependencies should've been installed, but if something went wrong feel free to create an issue reporting the problem.

This starts building, watching the changes and running the server.

Building

  yarn build

Release

We're automanting with release-it, but it's not working yet. For now, you should manually change the version in package.json.

Tests

  yarn test
  // or
  yarn test:watch

Lint

  yarn lint

Publishing

To publish, just run:

  make publish

It'll assure that tests were run and UI-Commons was built along with its component styleguide documentation, and was deployed in Github Pages.

Style guide

Take a look at docz documentation