Skip to content

serverless-plus/tencent-framework

Repository files navigation

Serverless Framework Component

Build Status

此组件非腾讯云官方组件,很多特性是实验性的。如果有相关疑问,请提交 issue 或者 pr。

Serverless Web 框架组件,可以方便将传统 Web 框架部署到腾讯云 Serverless 架构上,支持目前流行的所有 Web 框架。

目前支持框架:

  • Express.js
  • Koa.js
  • Egg.js
  • Next.js
  • Nuxt.js
  • Nest.js
  • Laravel
  • ThinkPHP
  • Flask
  • Django

支持无改造部署 Egg.js 项目,需要项目依赖 egg-core >= 4.19.0

愿景 🚀🚀🚀

由于现存 Web 框架组件太多了,配置文档比较零散,维护起来比较困难,但是 Web 框架组件的核心逻辑基本一致,为此作为第三方开发者开发了本适配所有 Web 框架的组件。而且 yaml 配置也进行了重新设计不兼容其他独立的框架组件配置

希望因此能够帮助到广大爱好 Serverless Components 的开发者。

示例项目

Examples

安装

通过 npm 安装最新版本的 Serverless Framework

$ npm install -g serverless

初始化项目

通过如下命令和模板链接,快速创建一个 Express 应用:

$ serverless init express-starter --name example
$ cd example

配置

以下是 Express 框架的 serverless.yml配置示例:

app: serverless
stage: dev
component: framework
name: express-demo

inputs:
  framework: express
  src:
    src: ./
    exclude:
      - .env
  region: ap-guangzhou
  faas:
    name: express-demo
  apigw:
    protocols:
      - http
      - https
    environment: release

全量配置

注意:inputsframework 参数是必须的,组件将根据该参数来对 Web 框架项目进行自动化部署,目前 framework 支持 Web 框架有 expresskoaeggnextnuxtnestlaravelthinkphpflaskdjango

可视化配置

新规范支持可视化配置,启动前先安装 @slsplus/cli 命令行工具:

$ npm i @slsplus/cli -g

启动可视化配置:

$ sp init -u

如下图所示:

UI Config

部署

$ sls deploy

License

MIT License

Copyright (c) 2020 Serverless Plus

About

Serverless Framework Components for Tencent Cloud

Resources

License

Stars

Watchers

Forks

Packages

No packages published