云开�?� CloudBase Framework

🚀 CloudBase Framework 是云开�?�官方出�?的�?�?�端一体化部署工具 🔥

无需改动代�?，�?�?�端一键托管部署，基于Serverless架构，加速访问，弹性�?�?维。

官网 / 文档 / 社区 / 问答

Table of Contents

• 快速开始
• 项目示例
• �?�件
• �?置示例
• Changelog
• License
• 优秀应用案例
• 在线交�?群
• Contributors
• 贡献指�?�

快速开始

1. 安装 CLI

npm install -g @cloudbase/cli@latest

2. �?始化一个应用

cloudbase init

3. 部署应用

cloudbase framework:deploy

一键部署一个 Vue CLI 创建的 项目

项目示例

	�??称	应用示例介�?	基于模�?�创建项目
	Vue 应用	Vue + 云函数 + �?��?网站部署	cloudbase init --template vue
	React 应用	React + 云函数 + �?��?网站部署	cloudbase init --template react-starter
	React 全栈应用	React + 云函数 + �?��?网站部署+ 云数�?�库	cloudbase init --template react-demo
	Nuxt SPA 应用	Nuxt SPA + 云函数 + �?��?网站部署	cloudbase init --template nuxt-spa
	Nuxt SSR 应用	Nuxt SSR + �?务端部署 + �?��?网站部署	cloudbase init --template nuxt-ssr
	Koa 应用	Koa + �?务端部署	cloudbase init --template koa-starter
	Express 应用	Express + �?务端部署	cloudbase init --template express-starter
	Nest 应用	Nest + �?务端部署	cloudbase init --template nest-starter
	Egg 应用	Egg + �?务端部署	cloudbase init --template egg-starter
	Node.js 云函数示例	Node.js 云函数	cloudbase init --template node-starter
	PHP 云函数示例	PHP 云函数	cloudbase init --template php-starter
	Java 云函数示例	Java 云函数	cloudbase init --template java-starter
	VuePresss 网站应用	VuePresss + �?��?网站部署	cloudbase init --template vuepress
	Node.js 云托管	Node.js + 云托管部署	cloudbase init --template node
	Aqueduct (Dart Server) 云托管	Aqueduct (Dart Server) + 云托管部署	cloudbase init --template dart
	Omi 应用	Omi + 云函数 + �?��?网站部署	cloudbase init --template omi-starter
	taro 应用	taro + 云函数 + �?��?网站部署	cloudbase init --template taro-starter
	Deno 云托管	Deno + 云托管部署	cloudbase init --template deno
	Next SSR 应用	Next SSR + �?务端部署 + �?��?网站部署	cloudbase init --template next-ssr
	Go 云函数	Go + 云函数	cloudbase init --template go-starter

模�?�

云开�?� CloudBase Framework 支�?模�?�工程，�??供了多�?语言和框架的模�?�项目，�?�需�?一个命令就�?�以创建一个开箱�?�用的工程，并且集�?了开�?��?构建�?部署的工作�?。

模�?��?�以自由定制，你�?�以根�?�自己的需�?创建任何语言�?框架的模�?�工程，并通过模�?�工程一键生�?你的�?始工程，原有的工程�?�以很容易改造�? cloudbase 的模�?�项目，�?�需�?创建一个 cloudbaserc.json，填写必�?的�?置�?��?�。

更多模�?�相关介�?，�?�以点击查看模�?�文档

�?�件

云开�?� CloudBase Framework 支�?�?�件机制，�??供了多�?应用框架和云资�?的�?�件，�?�需�?很少的�?置甚至 0 �?置就�?�以现有应用和云开�?� CloudBase Framework 框架进行集�?。

�?�件�?�以处�?�应用中的一些独立�?�元的构建�?部署�?开�?��?调试等�?程。例如 website �?�件�?�以处�?��?��?网站等�?�元，node �?�件�?�以处�?� koa �?express 等 node 应用。�?�件�?�以组�?�使用。

�?�件的�?置写在 cloudbaserc 文件中，目�?仅支�? JSON 文件，�?�续会支�? YAML。

�?�件的�?置�?�以手动填写，也�?�以自动生�?，目�?针对�?端框架支�?自动识别填写�?�件。

自动检测生�?�?�件�?置�?程

�?�以在项目目录下直接�?行 cloudbase 命令进行自动检测生�?�?�件�?置文件并部署

cloudbase


✔ 是�?�使用云开�?�部署当�?项目 <Projects/test/test-vue> ？ (Y/n) · true
✔ 选择关�?�环境 · webpage - [webpage:按�?计费]
   ______ __                   __ ____
  / ____// /____   __  __ ____/ // __ ) ____ _ _____ ___
 / /    / // __ \ / / / // __  // __  |/ __ `// ___// _ \
/ /___ / // /_/ // /_/ // /_/ // /_/ // /_/ /(__  )/  __/
\_________\____/ \__,_/ \__,_//_____/ \__,_//____/ \___/       __
   / ____/_____ ____ _ ____ ___   ___  _      __ ____   _____ / /__
  / /_   / ___// __ `// __ `__ \ / _ \| | /| / // __ \ / ___// //_/
 / __/  / /   / /_/ // / / / / //  __/| |/ |/ // /_/ // /   / ,<
/_/    /_/    \__,_//_/ /_/ /_/ \___/ |__/|__/ \____//_/   /_/|_|


 CloudBase Framework  info     Version v1.2.10
 CloudBase Framework  info     Github: https://github.com/TencentCloudBase/cloudbase-framework

 CloudBase Framework  info     EnvId webpage
? 检测到当�?项目包�?� Vue.js 项目

  🔨 构建脚本 `npm run build`
  📦 本地�?��?文件目录 `dist`

  是�?�需�?修改默认�?置 No
? 请输入应用唯一标识(支�?大�?写字�?数字�?�连字符, �?�一账�?�下�?能相�?�) test-vue
? 是�?�需�?�?存当�?项目�?置，�?存�?置之�?�下次�?会�?次询问 Yes
 CloudBase Framework  info     📦 install plugins

目�?支�?的�?�件列表

	�?�件	最新版本	�?�件介�?
	@cloudbase/framework-plugin-website		一键部署网站应用
	@cloudbase/framework-plugin-node		一键部署 Node 应用（支�?底层部署为函数或者 云托管）
	@cloudbase/framework-plugin-nuxt		一键部署 Nuxt SSR 应用
	@cloudbase/framework-plugin-function		一键部署函数资�?
	@cloudbase/framework-plugin-container		一键部署云托管容器�?务
	@cloudbase/framework-plugin-dart		一键部署 Dart 云托管
	@cloudbase/framework-plugin-database		一键声明�?部署云开�?� NoSQL 云数�?�库
	@cloudbase/framework-plugin-deno		一键部署 Deno 应用
	@cloudbase/framework-plugin-next		一键部署 Next SSR 应用
	@cloudbase/framework-plugin-mp		一键部署微信�?程�?应用

�?置示例

例如一个 Vue 的全栈项目，包�?�网站�?端和云函数

�?�以在在项目下手动创建一个 cloudbaserc.json，填写如下�?置文件，调用 cloudbase framework:deploy 进行部署

或者直接�?行 cloudbase �?�进行自动检测并部署

{
  "envId": "{{envId}}",
  "framework": {
    "plugins": {
      "client": {
        "use": "@cloudbase/framework-plugin-website",
        "inputs": {
          "buildCommand": "npm run build",
          "outputPath": "dist"
        }
      },
      "server": {
        "use": "@cloudbase/framework-plugin-function",
        "inputs": {
          "functionRootPath": "cloudfunctions",
          "functions": [
            {
              "name": "helloworld",
              "config": {
                "timeout": 5,
                "envVariables": {},
                "runtime": "Nodejs10.15",
                "memorySize": 128
              }
            }
          ]
        }
      }
    }
  }
}

更多�?置详细�?�数说明，�?�以查看�?置说明文档，点击查看�?置文档

Changelog

CloudBase Framework 的版本�?�更日志请�?�阅 changelog 文件

License

开�?�??议文档请�?�阅 Apache License 2.0

优秀应用案例

CloudBase CMS

Hi头�?

CloudBase TodoList

�?续�?集优秀应用案例

在线交�?群

微信群

QQ 群

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Booker Zhao 🚇 ⚠�? 💻 🔌	Weijia Wang 💻	hengechang 💻 🚇	Zijie Zhou 💻 🔌 📢	erikqin 💻 🚧 💡	Hanqin �?� 💡	Zem 💻
magenta �? 💻	TIANXIANG LAN 🖋	liyuanfeng 💻	白宦�? 💻	易良 💻	Sherry Zhang 💻 �?	RealyBig 💻
Saiya 📢 �?� �?	mirageql 💻 �?	Tab Liang 💻	juukee �?�	Albert Liu 💻	SearchFan �?�	Zira 💡

This project follows the all-contributors specification. Contributions of any kind welcome!

贡献指�?�

欢迎大家�?�与到 CloudBase Framework 的开�?�工作，贡献一份力�?

您�?�以选择如下的贡献方�?：

• 贡献技术文章
• 贡献应用模�?�和案例
• 贡献代�?，�??交 Pull Request
• �??馈 bug，�??交 Issue
• 在技术会议上�?�表技术演讲

贡献方�?请�?�考 贡献指�?� 文档