Skip to content

Latest commit

 

History

History
80 lines (59 loc) · 2.8 KB

README.md

File metadata and controls

80 lines (59 loc) · 2.8 KB
Raw

Born to build better enterprise frameworks and apps

NPM version NPM quality build status Test coverage David deps Known Vulnerabilities NPM download Gitter

Installation

$ npm install egg --save

Node.js >= 8.0.0 required.

Features

  • ✔︎ Built-in process management
  • ✔︎ Plugin system
  • ✔︎ Framework customization
  • ✔︎ Lots of plugins

Docs & Community

All the documentations (comments, README, etc.) are in English, except the tutorials and api documentations are still being translated. Feel free to join us and translate egg documentations. It's appreciated.

Getting Started

Follow the commands listed below.

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

Examples

See egg-examples.

How to Contribute

Please let us know how can we help. Do check out issues for bug reports or suggestions first.

To become a contributor, please follow our contributing guide.

License

MIT