![](https://raw.githubusercontent.com/eggjs/egg/master/docs/assets/egg-logo.png)

为企业级框架和应用而生的 Web 框架

[![NPM version][npm-image]][npm-url]
[![NPM quality][quality-image]][quality-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg
[quality-image]: http://npm.packagequality.com/shield/egg.svg?style=flat-square
[quality-url]: http://packagequality.com/#?package=egg
[travis-image]: https://img.shields.io/travis/eggjs/egg.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg.svg?style=flat-square
[codecov-url]: https://codecov.io/gh/eggjs/egg
[david-image]: https://img.shields.io/david/eggjs/egg.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg
[snyk-image]: https://snyk.io/test/npm/egg/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg
[download-image]: https://img.shields.io/npm/dm/egg.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg

## 安装

```bash
$ npm install egg --save
```

支持 Node.js 8.x 以上版本。

## 特性

- ✔︎ 内置多进程管理
- ✔︎ 高度可扩展的插件机制
- ✔︎ 深度框架定制
- ✔︎ 丰富的[插件](https://eggjs.org/badgeboard/)

## 文档和社区

- [官方站点 && 文档](https://eggjs.org/zh-cn/)
- [插件列表](https://github.com/search?q=topic%3Aegg-plugin&type=Repositories)
- [框架列表](https://github.com/search?q=topic%3Aegg-framework&type=Repositories)
- [插件依赖图](http://uml.mvnsearch.org/github/eggjs/egg/blob/master/docs/plugins.puml)

## 快速开始

```bash
$ npm install egg-init -g
$ egg-init --type simple showcase && cd showcase
$ npm install
$ npm run dev
$ open http://localhost:7001
```

## 示例

参见 [egg-examples](https://github.com/eggjs/examples)。

## 贡献代码

Please let us know what we can help, check [issues](https://github.com/eggjs/egg/issues) for bug reporting and suggestion.

If you are a contributor, follow [CONTRIBUTING](CONTRIBUTING.md).

## 开源协议

[MIT](LICENSE)