English | 简体中文

Features

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

Quickstart

Follow the commands listed below.

$ mkdir showcase && cd showcase
$ npm init egg --type=simple # Optionally pnpm create egg --type=simple
$ pnpm install
$ pnpm run dev
$ open http://localhost:7001

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

Monorepo Structure

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.

Development Commands

# 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

Documentations

• Documentations
• Plugins
• Frameworks
• Examples

Contributors

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.

Sponsors and Backers

License

MIT