English | 简体中文

• Built-in Process Management
• Plugin System
• Framework Customization
• Lots of plugins

Follow the commands listed below.

$ mkdir showcase && cd showcase $ pnpm create egg@beta $ pnpm install $ pnpm run dev $ open http://localhost:7001

Node.js >= 20.19.0 required, supports require(esm) by default.

This project is structured as a pnpm monorepo with the following packages:

• packages/egg - Main Eggjs framework
• examples/helloworld-commonjs - CommonJS example application
• examples/helloworld-typescript - TypeScript example application
• site - Documentation website

The monorepo uses pnpm catalog mode for centralized dependency management, ensuring consistent versions across all packages.

# Install dependencies for all packages pnpm install # Build all packages pnpm run build # Test all packages pnpm run test # Run specific package commands pnpm --filter=egg run test pnpm --filter=@examples/helloworld-typescript run dev pnpm --filter=site run dev

This monorepo uses changesets for version management and publishing. This allows for:

• Selective releases: Only changed packages are versioned and published
• Automatic changelogs: Generated from changeset summaries
• Better tracking: Clear documentation of what changed and why

To add a changeset for your changes:

pnpm changeset

For detailed information, see our Changeset Guide.

• Documentations
• Plugins
• Frameworks
• Examples

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, and review the repository guidelines for day-to-day development tips.

MIT