# feflow

**Repository Path**: IVWEB/feflow-cli

## Basic Information

- **Project Name**: feflow
- **Description**: 腾讯NOW直播IVWEB团队工程化解决方案
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 25
- **Forks**: 2
- **Created**: 2017-09-06
- **Last Updated**: 2022-08-17

## Categories & Tags

**Categories**: javascript-toolkits

**Tags**: None

## README

<p align="center">
  <a>
    <img width="200" src="https://pub.idqqimg.com/pc/misc/files/20170911/dc2b53e557654d88bd59bfb3aad0dc99.png">
  </a>
</p>


# feflow

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/iv-web/feflow/blob/master/LICENSE)
[![](https://img.shields.io/travis/iv-web/feflow.svg?style=flat-square)](https://travis-ci.org/iv-web/feflow)
[![Codecov](https://img.shields.io/codecov/c/github/iv-web/feflow/master.svg?style=flat-square)](https://codecov.io/gh/iv-web/feflow/branch/master)
[![Package Quality](http://npm.packagequality.com/shield/feflow-cli.svg)](http://packagequality.com/#?package=feflow-cli)
[![npm package](https://img.shields.io/npm/v/feflow-cli.svg?style=flat-square)](https://www.npmjs.org/package/feflow-cli)
[![NPM downloads](http://img.shields.io/npm/dt/feflow-cli.svg?style=flat-square)](https://npmjs.org/package/feflow-cli)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/iv-web/feflow/pulls)
[![Join the chat at https://gitter.im/feflow/feflow-cli](https://badges.gitter.im/feflow/feflow-cli.svg)](https://gitter.im/feflow/feflow-cli?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

致力于提升研发效率和规范的工程化解决方案，使用 [Node.js](https://nodejs.org/en/)编写.

## 特性

- 强大的插件机制，易于扩展.
- 和Yeoman集成，很容易通过Yeoman脚手架进行项目的初始化创建.
- 支持多种主流构建，包括webpack, fis等等
- 定义了一系列规范，包括Commit规范和ESLint规范.
- CLI的内核和插件层分离，当和最新版本不兼容时会采取全量更新和增量更新策略。

## 安装

``` bash
$ npm install feflow-cli -g
```
## 使用
```bash
# 初始化项目
$ feflow init

# 本地开发
$ feflow dev

# 代码质量检查
$ feflow lint

# 打包构建
$ feflow build
```

## 文档
- [开始使用](docs/getting-started.md)
- [开发一个插件](docs/plugin.md)
- [Git操作规范接入](docs/commit-standard.md)
- [ESLint操作规范](docs/eslint-standard.md)

## 整体架构
![](https://qpic.url.cn/feeds_pic/ajNVdqHZLLDsuocibo3TZ3GE5TMmVywG0lRyiayfI8D3icgW8FrkFKFOQ/)

## 如何贡献

1. 从目前已经存在的issue或者提出一个新的issue去讨论新的特性或者存在的bug.
2. 在Github上Fork [仓库](https://github.com/iv-web/feflow)_，然后在master或者其它分支上开始进行您的修改.
3. 编写测试用力表明某个bug被修复掉了或者新的特性可以正常工作.
4. 提交PR直到它被merge或者发布出去了. :) 记得把您添加进 [AUTHORS_](AUTHORS).

## 版本日志

[版本日志](CHANGELOG.md)

## 许可证

[MIT](https://tldrlegal.com/license/mit-license)