Born to build better enterprise frameworks and apps with Node.js & koa
JavaScript CSS Shell

README.md

Born to build better enterprise frameworks and apps

NPM version build status Test coverage David deps Known Vulnerabilities npm download

Installation

$ npm install egg --save

Node.js >= 6.0.0 required.

Features

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

Docs & Community

All the resources are in English(comments, README, etc.), with one exception, guides are still working in process. Welcome to join us to translate egg documents, we are glad to see that.

Getting Started

Follow the step

$ 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 what we can help, check issues for bug reporting and suggestion.

If you are a contributor, follow CONTRIBUTING.

License

MIT