@descco/ui-core/README.md

Descco UI

# Descco UI - Core

## Prerequisites

- [Node >= v6.10.3](https://nodejs.org/en/)
- NPM >= v3.10.10
- [Yarn >= v0.24.4](https://yarnpkg.com/en/docs/install#linux-tab) or `npm install -g yarn`

## Install

```
yarn
```

## In the your project

```bash
npm install --save-dev @descco/ui-core
// or
yarn add --dev @descco/ui-core
```

```bash
// package.json
"devDependencies": {
  "@descco/ui-core": "vX.X.X"
}
```

## Build

```
yarn build
```

## Lint

```bash
yarn lint
//[Rules in ESLint](http://eslint.org/docs/rules/)
```

## Test

```
yarn test
```

## Release

```bash
 npm install -g release-it
```
### Usage

Current release: v1.0.0-beta.4

Command:

```bash
release-it v1.0.0-beta.5
```

Questions and answers

**Release source repo**

```sh
- ? Show updated files? `Yes`
- M  package.json

- ? Commit (Release v1.0.0-beta.5)? `Yes`
- ? Tag (v1.0.0-beta.5)? `Yes`
- ? Push? `Yes`
- ? Publish "iron-fist" to npm? `No`
```

## Manual

1. [Git Flow](./docs/manual/01-git-flow.md)
2. [Commits](./docs/manual/02-commits.md)
3. [Architecture](./docs/manual/03-architecture.md)
4. [Dependencies](./docs/manual/04-dependencies.md)
5. [Technologies](./docs/manual/05-technologies.md)
6. [Identation (code style)](./docs/manual/06-identation-code-style.md)
7. [CSS (code style)](./docs/manual/07-css-code-style.md)
8. [Javascript (code style)](./docs/manual/08-javascript-code-style.md)

**[⬆ back to the top](#prerequisites)**