|
|
Born to build better enterprise frameworks and apps
|
|
[![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]
|
[![Gitter][gitter-image]][gitter-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
|
[gitter-image]: https://img.shields.io/gitter/room/eggjs/egg.svg?style=flat-square
|
[gitter-url]: https://gitter.im/eggjs/egg
|
|
## Installation
|
|
```bash
|
$ npm install egg --save
|
```
|
|
Node.js >= 8.0.0 required.
|
|
## Features
|
|
- ✔︎ Built-in process management
|
- ✔︎ Plugin system
|
- ✔︎ Framework customization
|
- ✔︎ Lots of [plugins](https://github.com/search?q=topic%3Aegg-plugin&type=Repositories)
|
|
## Docs & Community
|
|
- [Website && Documentations](https://eggjs.org/en/index.html)
|
- [Plugins](https://github.com/search?q=topic%3Aegg-plugin&type=Repositories)
|
- [Frameworks](https://github.com/search?q=topic%3Aegg-framework&type=Repositories)
|
|
## Getting Started
|
|
Follow the commands listed below.
|
|
```bash
|
$ mkdir showcase && cd showcase
|
$ npm init egg --type=simple
|
$ npm install
|
$ npm run dev
|
$ open http://localhost:7001
|
```
|
|
## Examples
|
|
See [egg-examples](https://github.com/eggjs/examples).
|
|
## How to Contribute
|
|
Please let us know how can we help. Do check out [issues](https://github.com/eggjs/egg/issues) for bug reports or suggestions first.
|
|
To become a contributor, please follow our [contributing guide](CONTRIBUTING.md).
|
|
## License
|
|
[MIT](LICENSE)
|
