# 🐸 @omni-door/tpl-component-library-react
The React component-library-react project template

[![NPM downloads](http://img.shields.io/npm/dm/%40omni-door%2Ftpl-component-library-react.svg?style=flat-square)](https://www.npmjs.com/package/@omni-door/tpl-component-library-react)
[![npm version](https://badge.fury.io/js/%40omni-door%2Ftpl-component-library-react.svg)](https://badge.fury.io/js/%40omni-door%2Ftpl-component-library-react)
[![Build Status](https://travis-ci.com/omni-door/tpl-component-library-react.svg?branch=master)](https://travis-ci.com/omni-door/tpl-component-library-react)
[![codecov](https://codecov.io/gh/omni-door/tpl-component-library-react/branch/master/graph/badge.svg)](https://codecov.io/gh/omni-door/tpl-component-library-react)
[![install size](https://packagephobia.now.sh/badge?p=%40omni-door%2Ftpl-component-library-react)](https://packagephobia.now.sh/result?p=%40omni-door%2Ftpl-component-library-react)
[![license](http://img.shields.io/npm/l/%40omni-door%2Ftpl-component-library-react.svg)](https://github.com/omni-door/tpl-component-library-react/blob/master/LICENSE)

## Install
* Clone the repo: `git@github.com:omni-door/tpls.git`

* Install with [npm](https://www.npmjs.com/package/@omni-door/tpl-component-library-react): `npm install @omni-door/tpl-component-library-react`

* Install with [Yarn](https://yarnpkg.com/en/package/@omni-door/tpl-component-library-react): `yarn add @omni-door/tpl-component-library-react`

## Templates
| folder | file |
| --- | --- |
| babel | babel.config.js |
| bisheng | bisheng.config.js & posts/README.md |
| commitlint | commitlint.config.js |
| editor | .editorconfig |
| docz | .doczrc.js & gatsby-config.js |
| eslint | .eslintrc.js |
| ignore | .eslintignore & .gitignore & .npmignore & .prettierignore |
| jest | jest.config.js |
| new | the standard templates for `omni new` command |
| omni | omni.config.js |
| package | package.json |
| prettier | prettier.config.js |
| readme | README.md |
| source | the standard templates in `src` folder |
| storybook | .storybook/config.js & .storybook/addons.js & .storybook/manager-head.html & .storybook/webpack.config.js |
| styleguidist | styleguide.config.js |
| stylelint | stylelint.config.js |
| tsconfig | tsconfig.json |
| vsc | .vscode/settings.json |