October 17, 2020

535 words 3 mins read



A Node.js Serverless Framework for front-end/full-stack developers. Build the application for next decade. Works on AWS, Alibaba Cloud, Tencent Cloud and traditional VM/Container. Super easy integrate with React and Vue.

repo name midwayjs/midway
repo link https://github.com/midwayjs/midway
homepage http://midwayjs.org/
language TypeScript
size (curr.) 58372 kB
stars (curr.) 3229
created 2018-07-12
license MIT License

English | 简体中文


Detailed introduction article: Alibaba Midway Serverless release v1.0, welcome Star this repository.

Midway Serverless is a serverless framework used to build Node.js cloud functions. Helps you significantly reduce maintenance costs and focus more on product development in the cloud-native era.

  • 1、Make applications easier to maintain and delivering
    • 🐦 Provided multiple sets of integrated development solutions for community front-end React, Vue, etc.;
    • 🐯 Provides standard cloud platform function entry and exit parameter definitions;
    • 🐶 Provides TypeScript support to facilitate application expansion and definition;
    • 🐱 Provides a complete Midway system iconic dependency injection solution;
  • 2、 Ecology is more lightweight and free
    • 🦁 The function system reuses the ecological and Web middleware capabilities of koa, which is more handy when dealing with traditional Web;
    • 🐴 Provide an ecological chain of egg components reusing egg plug-ins, enterprise-level development links are simpler and smoother;
    • 🐘 The decorator capabilities of the Midway system are unified, making the traditional Web migration to the Serverless system faster and better;
  • 3、Easier migration between platforms
    • 🐒 By providing a unified configuration specification and entry smoothing mechanism, the code is basically the same on each platform;
    • 🦊 Expanding the runtime APIs of different cloud platforms can not only load common inter-platform extensions, but also access the company’s internal private deployment solutions;


Quick Start

Install CLI

First, you need to install Node (> 10.9), and npm.

npm install @midwayjs/faas-cli -g

Create First Function

Execute the following command.

f create

You will see the following scaffolding options, choose scaffolding or sample code, such as faas-standard.

Generating boilerplate...
? Hello, traveller.
  Which template do you like? …

 ⊙ Boilerplate
❯ faas-standard - A serverless boilerplate for aliyun fc, tencent scf and so on
  faas-layer - A serverless runtime layer boilerplate

 ⊙ Examples
  faas-react - A serverless example with react
  faas-vue - A serverless example with vue

VSC Plugin

Deploy Function

Execute the following command to publish to the cloud platform.

f deploy

Midway Serverless support Alibaba Cloud and Tencent Cloud. Amazon Lambda will be soon.

Quick Start - Front-end Integration Examples

The following examples of front-end integration are currently connected. Visit the Midway Gallery to find more examples.

React Vue

The visualization project of COVID-2019 pandemic developed by react integration, it can be created by selecting faas-covid19 with command f create.


Project Version Description
midway-serverless faas-status A new generation of progressive Serverless development framework
runtime-engine runtime-engine-status Common basic Serverless runtime
serverless-fc-starter serverless-fc-starter-status Alibaba Cloud FC function launcher
serverless-scf-starter serverless-scf-starter-status Tencent Cloud SCF Function Launcher
midway midway-status Future-oriented web development framework based on dependency injection

Community partners


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.

This project exists thanks to all the people who contribute.


Midway Serverless based MIT licensed.


Alibaba Open Source

comments powered by Disqus