midway
Version:
A Node.js Serverless Framework for front-end/full-stack developers. Build the application for next decade.
88 lines (57 loc) • 5.71 kB
Markdown
<p align="center">
<a href="https://midwayjs.org/" target="blank"><img src="https://img.alicdn.com/imgextra/i1/O1CN01xQLU011T2R7PHksIv_!!6000000002324-2-tps-1200-616.png" width="1000" alt="Midway Logo" /></a>
</p>
<p align="center">Midway 是一个适用于构建 Serverless 服务,传统应用、微服务,小程序后端的 <a href="http://nodejs.org" target="_blank">Node.js</a> 框架。</p>
<p align="center">
<a href="https://github.com/midwayjs/midway/blob/master/LICENSE" target="_blank"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="GitHub license" /></a>
<a href=""><img src="https://img.shields.io/github/tag/midwayjs/midway.svg" alt="GitHub tag"></a>
<a href="https://travis-ci.org/midwayjs/midway"><img src="https://travis-ci.org/midwayjs/midway.svg?branch=develop" alt="Build Status"></a>
<a href="https://codecov.io/gh/midwayjs/midway/branch/master"><img src="https://img.shields.io/codecov/c/github/midwayjs/midway/master.svg" alt="Test Coverage"></a>
<a href="https://lernajs.io/"><img src="https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg" alt="lerna"></a>
<a href="https://snyk.io/test/npm/midway"><img src="https://snyk.io/test/npm/midway/badge.svg" alt="Known Vulnerabilities"></a>
<a href="https://github.com/midwayjs/midway/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"></a>
<a href="https://www.codacy.com/app/czy88840616/midway?utm_source=github.com&utm_medium=referral&utm_content=midwayjs/midway&utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/856737478fa94e78bce39d5fc2315cec" alt="Codacy Badge"></a>
<a href="#backers"><img src="https://opencollective.com/midway/backers/badge.svg" alt="Backers on Open Collective"></a> <a href="#sponsors"><img src="https://opencollective.com/midway/sponsors/badge.svg" alt="Sponsors on Open Collective"></a>
<a href="https://gitpod.io/#https://github.com/midwayjs/midway"><img src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod" alt="Gitpod Ready-to-Code"></a>
<a href="https://github.com/midwayjs/mwts"><img src="https://img.shields.io/badge/code%20style-midwayjs-brightgreen.svg" alt="Code Style: MidwayJS"></a>
</p>
[English](./README.en-US.md) | 简体中文
## 特性
- [x] **跨平台**:支持阿里云、腾讯云等多平台的Serverless框架
- [x] **场景多样化**:Midway支持传统应用、Serverless函数、微服务、小程序后端等多种场景
- [x] **插件多样化**:支持Koa、express、egg等多种插件
- [x] **示例丰富**: 官方提供多种Node场景的示例代码,方便开发者快速上手。
- [x] **维护成本低**:良好的应用程序分层和解耦能力
- [x] **丰富的开发者工具**: 官方提供了vscode插件来提升开发效率。
## 描述
Midway 是一个适用于构建 Serverless 服务,传统应用、微服务,小程序后端的 Node.js 框架。
Midway可以使用 koa,express 或 EggJS 作为基本的 Web 框架。它还提供了独立使用的基本解决方案,例如 Socket.io,GRPC,Dubbo.js 和 RabbitMQ 等。
此外,Midway 也适用于前端/全栈开发人员的Node.js无服务器框架。构建下一个十年的应用程序。可在AWS,阿里云,腾讯云和传统VM /容器上运行。与 React 和 Vue 轻松集成。 🌈
## 快速上手
```bash
npm i @midwayjs/cli -g --registry=https://registry.npm.taobao.org
## 创建项目
mw new helloworld
## 进入项目路径
cd helloworld && npm run dev
```
你也可以在阿里云官网知行实验室,学习 Midway [相关的课程](https://start.aliyun.com/handson-lab)。
## 文档和社区

- [官网](https://midwayjs.org)
- 要查看 v2 中文文档, 请访问 [中文文档](https://www.yuque.com/midwayjs/midway_v2) 📚
- 要查看 v1 中文文档, 请访问 [中文文档](https://www.yuque.com/midwayjs/midway_v1) 📚
## 示例

请访问 [midway-examples](http://demo.midwayjs.org/).
## VSC Plugin

## 答疑
群里会有热心的朋友,也会有新版本发布推送。钉钉扫码加入答疑群

## 贡献
请告知我们可以为你做些什么,不过在此之前,请检查一下是否有 [已经存在的Bug或者意见](http://github.com/midwayjs/midway/issues)。
如果你是一个代码贡献者,请参考代码贡献规范。
## License
我们的代码使用 [MIT](http://github.com/midwayjs/midway/blob/master/LICENSE) 协议,请放心使用。
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fmidwayjs%2Fmidway?ref=badge_large)