@olist/united
Version:
olist design language system
99 lines (66 loc) • 2.71 kB
Markdown
## Attention:
**United V1** (`@olist/united@1.x.x`) is now released.
As it is a Major version, some breaking changes happened.
View the [Changelog](CHANGELOG.md).
The previous major (`0.x.x`) is hosted in the `v0.x.x` branch.
Beware that any new components, bugfixes and etc, to be added to the previous version **must also be added to the current version**.
---
[](https://circleci.com/gh/olist/olist-united)
United is a component-based UI library for Olist's design system using React ecosystem.
## Installing / Getting started
```shell
yarn add @olist/united
```
It has `react`, `react-dom`, `styled-components`, `styled-map` and `styled-system` as peer dependencies. So, **be careful whether some warning about version compatibility pops up or not** after the installation.
After that you'll be able to import on you project and use the components and helpers.
```js
import { Text } from '@olist/united';
```
Take a look at the [components documentation](https://olist.github.io/olist-united/) so that you can make the most on your job.
## 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 for the united, then 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.
```shell
git clone git@gitlab.olist.io:frontend/olist-united.git
cd olist-united/
yarn
```
If it's everything okay on your environment all united dependencies were installed, but if something went wrong feel free to create an issue reporting the problem.
### Running the server
```shell
yarn dev
```
This makes the project start building. After that, you can watch the changes in your console.
### Release
We're automanting with `release-it`, but it's **not working yet.**
For a while, you ought to change the version by hand in `package.json`.
### Tests
```shell
yarn test
// or
yarn test:watch
```
### Lint
```shell
yarn lint
```
### Build
```shell
yarn build
```
### Publishing
To publish, just run:
```shell
make publish
```
It'll assure that tests were run and United was built along with its component styleguide documentation, and was deployed in Github Pages.
## Style guide
Take a look at [documentation](https://united.olist.io)