What is this?
Egg is a Node.js framework for building better enterprise frameworks and web apps, built on top of Koa. It has about 19,000 GitHub stars and ships documentation in English and Simplified Chinese.
Egg is a Node.js framework for building better enterprise frameworks and web apps, built on top of Koa. It has about 19,000 GitHub stars and ships documentation in English and Simplified Chinese.Is it a framework I build my app on, or a library I call from my code?A full framework: your application is built on top of it, with Koa as the underlying server layer. The main package, packages/egg, is described in the repo as the main Eggjs framework.
A full framework: your application is built on top of it, with Koa as the underlying server layer. The main package, packages/egg, is described in the repo as the main Eggjs framework.How do I get an app running with it?Follow the Quickstart commands at the top of the README. The repo also ships two runnable hello-world apps — examples/helloworld-commonjs and examples/helloworld-typescript — you can start from.
Follow the Quickstart commands at the top of the README. The repo also ships two runnable hello-world apps — examples/helloworld-commonjs and examples/helloworld-typescript — you can start from.What do I need installed before I start?Node.js 22.18.0 or newer. To run the repo's DAL, ORM and Redis tests locally you also start Docker services with MySQL 8 and Redis 7, matching the CI versions.
Node.js 22.18.0 or newer. To run the repo's DAL, ORM and Redis tests locally you also start Docker services with MySQL 8 and Redis 7, matching the CI versions.Any pitfalls in that local test setup?Fixtures expect the default ports 127.0.0.1:3306 for MySQL and 6379 for Redis, and the start command stops if either is taken. Run 'ut run dev:services:reset' before switching MySQL image families, since data directories are not downgrade-compatible.
Fixtures expect the default ports 127.0.0.1:3306 for MySQL and 6379 for Redis, and the start command stops if either is taken. Run 'ut run dev:services:reset' before switching MySQL image families, since data directories are not downgrade-compatible.What does Egg give me out of the box?Four headline features: built-in process management, a plugin system, framework customization, and lots of ready-made plugins to extend your app.
Four headline features: built-in process management, a plugin system, framework customization, and lots of ready-made plugins to extend your app.Why does it call itself an enterprise framework?The name is literal — it was 'born to build better enterprise frameworks and apps': larger server-side applications, with framework customization so teams can shape Egg into their own in-house framework.
The name is literal — it was 'born to build better enterprise frameworks and apps': larger server-side applications, with framework customization so teams can shape Egg into their own in-house framework.What does the repository look like inside?It is a utoo monorepo: packages/egg holds the main framework and site/ hosts the documentation website, with dependency versions managed centrally across all packages.
It is a utoo monorepo: packages/egg holds the main framework and site/ hosts the documentation website, with dependency versions managed centrally across all packages.Is Egg still actively maintained?Yes — the project dates back to 2016, has about 19,000 stars, is not archived, and runs CI workflows for unit, e2e and release pipelines.
Yes — the project dates back to 2016, has about 19,000 stars, is not archived, and runs CI workflows for unit, e2e and release pipelines.What are similar projects?koa, elpis, crystal, apollo-server, fastify, hapi, carno.js, node-restify
koa, elpis, crystal, apollo-server, fastify, hapi, carno.js, node-restifyWhich topics is it in?app-framework, koa, middleware, plugins, web-framework, node, enterprise, plugin-system, monorepo, developers, backend, plugin
app-framework, koa, middleware, plugins, web-framework, node, enterprise, plugin-system, monorepo, developers, backend, plugin