README.md

Beidou

🌌 Isomorphic framework for server-rendered React apps

Chinese Documentation - 中文文档

Features

• ✔︎ High performance, 2-5 times speedup compares to client-side rendering
• ✔︎ Search engine optimization(SEO)
• ✔︎ ES6/ES7/ES8 supported
• ✔︎ TypeScript supported
• ✔︎ React renderToNodeStream supported
• ✔︎ SCSS/Sass with autoprefixer supported
• ✔︎ Auto router supported
• ✔︎ Extends default webpack config supported
• ✔︎ View rendering middleware supported
• ✔︎ User-friendly CLI tool
• ✔︎ Lots of plugins

Release 2.0

New Features

• BREAKING CHANGE: Upgrade internal babel to 7

• BREAKING CHANGE: Upgrade internal webpack to 4

• Completely TypeScript Support, enable with one line config:

// package.json

{
  "config": {
    "typescript": true
  }
}

see typescript example for more detail.

Quick start

$ npm install beidou-cli -g
$ beidou init
$ npm run dev

Navigate to http://localhost:6001/

Boilerplate

• simple
• advanced
• typescript
• with redux
• with css-modules

Documentation

• Quick Start
• Step by Step
  • Environment
  • Directory Structure
  • Step by Step
• Basics
  • Built-in Objects
  • Runtime Environment
  • Configuration
  • Plugins
  • Middlewares
  • Router
  • Controller
  • Service
  • Schedule
  • Extend
  • Custom startup
• Core
  • Development
  • Unit Testing
  • Logger
  • HttpClient
  • Cookie & Session
  • Cluster and IPC
  • Ismorphic Render
  • Error Handling
  • Security
  • Multi-language
• Deployment
  • Deployment
  • DevOps
  • Docker
• Tutorials
  • Progressive
  • MySQL
  • Restful API
  • Async Function
• Advanced
  • How It Works
  • Loader
  • Plugin Development
  • Cluster Enhancement
  • Monitor
  • Performance
  • Memory Leaks
  • SSR Attentions

Articles

• D2 - High Reliability & Performance Isomorphic App
• High performance isomorphic-rendered React Apps
• How to resolve nodejs memory leak
• Nodejs application performance optimization

Performance

• Isomorphic rendering performance VS client side rendering performance in 3G network

• Performance comparison in different network environment

Need Help?

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

DingTalk group supported

DingTalk Group Number: 23374510

License

MIT