feat: optimize deploy flow

.gitignore

@@ -20,4 +20,4 @@ build/
 env.js
 package-lock.json
 test
-yarn.lock
+yarn.lock

.travis.yml

@@ -1,7 +1,6 @@
 language: node_js
 
 node_js:
-  - 8
   - 10
 
 install:
@@ -18,5 +17,7 @@ jobs:
       deploy:
         provider: script
         skip_cleanup: true
+        on:
+          branch: master
         script:
           - npm run release

README.md

@@ -1,149 +1,149 @@
-[![Serverless Components](https://img.serverlesscloud.cn/2020210/1581352135771-express.png)](http://serverless.com)
+# Serverless Nest.js
 
-<br/>
+**腾讯云 Nest.js 组件** ⎯⎯⎯ 通过使用 [Serverless Framework](https://github.com/serverless/components/tree/cloud)，基于云上 Serverless 服务（如网关、云函数等），实现“0”配置，便捷开发，极速部署你的 Nest.js 应用。
 
-**腾讯云 Express 组件** ⎯⎯⎯ 通过使用 [Tencent Serverless Framework](https://github.com/serverless/components/tree/cloud)，基于云上 Serverless 服务（如网关、云函数等），实现“0”配置，便捷开发，极速部署你的 express 应用，Express 组件支持丰富的配置扩展，提供了目前最易用、低成本并且弹性伸缩的 Experss 项目开发/托管能力。
-<br/>
+> 注意：本项目仅支持使用 [ExpressAdapter](https://docs.nestjs.com/faq/http-adapter) 的 Nest.js 项目。
 
-特性介绍：
+### 安装
 
-- [x] **按需付费** - 按照请求的使用量进行收费，没有请求时无需付费
-- [x] **"0"配置** - 只需要关心项目代码，之后部署即可，Serverless Framework 会搞定所有配置。
-- [x] **极速部署** - 仅需几秒，部署你的整个 express 应用。
-- [x] **实时日志** - 通过实时日志的输出查看业务状态，便于直接在云端开发应用。
-- [x] **云端调试** - 针对 Node.js 框架支持一键云端调试能力，屏蔽本地环境的差异。
-- [x] **便捷协作** - 通过云端的状态信息和部署日志，方便的进行多人协作开发。
-- [x] **自定义域名** - 支持配置自定义域名及 HTTPS 访问
+通过 npm 安装最新版本的 Serverless Framework
 
-<br/>
+```bash
+$ npm install -g serverless
+```
 
-<img align="right" width="400" src="https://scf-dev-tools-1253665819.cos.ap-guangzhou.myqcloud.com/express_demo_light_sm_resize.gif" />
+### 创建
 
-快速开始：
+通过如下命令和模板链接，快速创建一个 Nest.js 应用：
 
-1. [**安装**](#1-安装)
-2. [**创建**](#2-创建)
-3. [**部署**](#3-部署)
-4. [**配置**](#4-配置)
-5. [**开发调试**](#5-开发调试)
-6. [**查看状态**](#6-查看状态)
-7. [**移除**](#7-移除)
+```bash
+$ npm i -g @nestjs/cli
+$ nest new serverless-nestjs
+$ cd serverless-nestjs
+```
 
-更多资源：
+执行如下命令，安装应用的对应依赖
 
-- [**架构说明**](#架构说明)
-- [**账号配置**](#账号配置)
+```
+$ npm install
+```
 
-&nbsp;
+### 项目改造
 
-### 1. 安装
+1. 由于云端函数执行时不需要监听端口的，所以我们需要修改下入口文件 `src/main.ts`，如下：
 
-通过 npm 安装最新版本的 Serverless Framework
+```typescript
+import { NestFactory } from '@nestjs/core'
+import { join } from 'path'
+import { AppModule } from './app.module'
 
-```bash
-$ npm install -g serverless
-```
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule)
 
-### 2. 创建
+  return app
+}
 
-通过如下命令和模板链接，快速创建一个 express 应用：
+// 注意: 通过注入 NODE_ENV 为 local，来方便本地启动服务，进行开发调试
+const isLocal = process.env.NODE_ENV === 'local'
+if (isLocal) {
+  bootstrap().then((app) => {
+    app.listen(3000, () => {
+      console.log(`Server start on http://localhost:3000`)
+    })
+  })
+}
 
-```bash
-$ serverless create --template-url https://github.com/serverless-components/tencent-express/tree/v2/serverless-express
-$ cd serverless-express
+// 导出启动函数，给 sls.js 使用
+export { bootstrap }
 ```
 
-执行如下命令，安装 express 应用的对应依赖
+2. 项目根目录下新增 `sls.js` 文件，用来提供给 Nest.js 组件使用：
 
+```js
+// 注意: 根据实际项目入口文件名进行修改，此 demo 为默认情况
+const { bootstrap } = require('./dist/main')
+
+module.exports = bootstrap
 ```
-$ npm install
-```
 
-### 3. 部署
+> 注意：实际开发可根据个人项目路径，来导出启动函数 `bootstrap`。
+
+### 部署
 
-在 `serverless.yml` 文件下的目录中运行 `serverless deploy` 进行 express 项目的部署。第一次部署可能耗时相对较久，但后续的二次部署会在几秒钟之内完成。部署完毕后，你可以在命令行的输出中查看到你 express 应用的 URL 地址，点击地址即可访问你的 express 项目。
+由于 Nest.js 项目是 TypeScript，部署前需要编译成 JavaScript，在项目中执行编译命令即可：
 
-**注意：**
+```bash
+$ npm run build
+```
 
-如您的账号未[登陆](https://cloud.tencent.com/login)或[注册](https://cloud.tencent.com/register)腾讯云，您可以直接通过`微信`扫描命令行中的二维码进行授权登陆和注册。
+在 `serverless.yml` 文件下的目录中运行 `serverless deploy` 进行 Nest.js 项目的部署。第一次部署可能耗时相对较久，但后续的二次部署会在几秒钟之内完成。部署完毕后，你可以在命令行的输出中查看到你 nestjs 应用的 URL 地址，点击地址即可访问你的 Nest.js 项目。
 
-如果出现了 `internal server error` 的报错，请检查是否在创建模板后没有运行 `npm install`。
+> **注意：** 如您的账号未 [登录](https://cloud.tencent.com/login) 或 [注册](https://cloud.tencent.com/register) 腾讯云，您可以直接通过 `微信` 扫描命令行中的二维码进行授权登陆和注册。
 
 如果希望查看更多部署过程的信息，可以通过`sls deploy --debug` 命令查看部署过程中的实时日志信息，`sls`是 `serverless` 命令的缩写。
 
-<br/>
-
-### 4. 配置
+### 配置
 
-Express 组件支持 0 配置部署，也就是可以直接通过配置文件中的默认值进行部署。但你依然可以修改更多可选配置来进一步开发该 Express 项目。
+nestjs 组件支持 0 配置部署，也就是可以直接通过配置文件中的默认值进行部署。但你依然可以修改更多可选配置来进一步开发该 nestjs 项目。
 
-以下是 Express 组件的 `serverless.yml`完整配置说明：
+以下是 nestjs 组件的 `serverless.yml` 简单配置示例：
 
 ```yml
 # serverless.yml
 
-component: express # (required) name of the component. In that case, it's express.
-name: expressDemo # (required) name of your express component instance.
+component: nestjs # (required) name of the component. In that case, it's nestjs.
+name: nestjsDemo # (required) name of your nestjs component instance.
 org: orgDemo # (optional) serverless dashboard org. default is the first org you created during signup.
 app: appDemo # (optional) serverless dashboard app. default is the same as the name property.
 stage: dev # (optional) serverless dashboard stage. default is dev.
 
 inputs:
-  src: ./ # (optional) path to the source folder. default is a hello world app.
-  functionName: expressDemo
+  src:
+    src: ./ # (optional) path to the source folder. default is a hello world app.
+    exclude:
+      - .env
+  functionName: nestjsDemo
   region: ap-guangzhou
   runtime: Nodejs10.15
-  exclude:
-    - .env
   apigatewayConf:
     protocols:
       - http
       - https
     environment: release
 ```
 
-点此查看[全量配置及配置说明](https://github.com/serverless-components/tencent-express/blob/v2/docs/configure.md)
+点此查看[全量配置及配置说明](https://github.com/serverless-components/tencent-nestjs/tree/master/docs/configure.md)
 
 当你根据该配置文件更新配置字段后，再次运行 `serverless deploy` 或者 `serverless` 就可以更新配置到云端。
 
-### 5. 开发调试
+### 远程调试云函数
 
-部署了 Express.js 应用后，可以通过开发调试能力对该项目进行二次开发，从而开发一个生产应用。在本地修改和更新代码后，不需要每次都运行 `serverless deploy` 命令来反复部署。你可以直接通过 `serverless dev` 命令对本地代码的改动进行检测和自动上传。
+部署了 nestjs.js 应用后，可以通过开发调试能力对该项目进行二次开发，从而开发一个生产应用。在本地修改和更新代码后，不需要每次都运行 `serverless deploy` 命令来反复部署。你可以直接通过 `serverless dev` 命令对本地代码的改动进行检测和自动上传。
 
 可以通过在 `serverless.yml`文件所在的目录下运行 `serverless dev` 命令开启开发调试能力。
 
 `serverless dev` 同时支持实时输出云端日志，每次部署完毕后，对项目进行访问，即可在命令行中实时输出调用日志，便于查看业务情况和排障。
 
 除了实时日志输出之外，针对 Node.js 应用，当前也支持云端调试能力。在开启 `serverless dev` 命令之后，将会自动监听远端端口，并将函数的超时时间临时配置为 900s。此时你可以通过访问 chrome://inspect/#devices 查找远端的调试路径，并直接对云端代码进行断点等调试。在调试模式结束后，需要再次部署从而将代码更新并将超时时间设置为原来的值。详情参考[开发模式和云端调试](https://cloud.tencent.com/document/product/1154/43220)。
 
-### 6. 查看状态
+### 查看状态
 
 在`serverless.yml`文件所在的目录下，通过如下命令查看部署状态：
 
 ```
 $ serverless info
 ```
 
-### 7. 移除
+### 移除
 
-在`serverless.yml`文件所在的目录下，通过以下命令移除部署的 Express 服务。移除后该组件会对应删除云上部署时所创建的所有相关资源。
+在`serverless.yml`文件所在的目录下，通过以下命令移除部署的 nestjs 服务。移除后该组件会对应删除云上部署时所创建的所有相关资源。
 
 ```
 $ serverless remove
 ```
 
 和部署类似，支持通过 `sls remove --debug` 命令查看移除过程中的实时日志信息，`sls`是 `serverless` 命令的缩写。
 
-## 架构说明
-
-Express 组件将在腾讯云账户中使用到如下 Serverless 服务：
-
-- [x] **API 网关** - API 网关将会接收外部请求并且转发到 SCF 云函数中。
-- [x] **SCF 云函数** - 云函数将承载 Express.js 应用。
-- [x] **CAM 访问控制** - 该组件会创建默认 CAM 角色用于授权访问关联资源。
-- [x] **COS 对象存储** - 为确保上传速度和质量，云函数压缩并上传代码时，会默认将代码包存储在特定命名的 COS 桶中。
-- [x] **SSL 证书服务** - 如果你在 yaml 文件中配置了 `apigatewayConf.customDomains` 字段，需要做自定义域名绑定并开启 HTTPS 时，也会用到证书管理服务和域名服务。Serverless Framework 会根据已经备案的域名自动申请并配置 SSL 证书。
-
 ## 账号配置
 
 当前默认支持 CLI 扫描二维码登录，如您希望配置持久的环境变量/秘钥信息，也可以本地创建 `.env` 文件