Skip to content

快速开始

在开始之前

在开始之前,你需要完成以下事情:

  • 创建一个 Vercel 账号
  • 创建一个 Vercel 项目

你可以选择直接开始或者使用VCLight Cli开始(推荐)。

创建一个 VCLight 应用

在本节中,我们将介绍如何在本地搭建一个空白的 VCLight 项目。创建的项目将使用 TypeScript ,并且使用基于 Vercel 的本地构建和调试。

当然,如果你偏好 JavaScript ,你也可以选择 JavaScript ,但是接下来的步骤可能需要进行一些调整。

首先,确保你安装了最新版本的 Node.js

然后创建一个空的项目

shell
$ npm init -y
$ npm init -y

安装依赖

接下来,我们需要安装 Vercel 和 VCLight 的包,还有ts类型支持。

shell
$ npm install vercel vclight
$ npm install @vercel/node -D
$ npm install vercel vclight
$ npm install @vercel/node -D
shell
$ yarn add vercel vclight
$ yarn add @vercel/node -D
$ yarn add vercel vclight
$ yarn add @vercel/node -D
shell
$ pnpm add vercel vclight
$ pnpm add @vercel/node -D
$ pnpm add vercel vclight
$ pnpm add @vercel/node -D

创建入口点

接下来,你需要创建项目的入口点文件 src/main.ts

TypeScript
import VCLight from "vclight";
import { VercelRequest, VercelResponse } from "@vercel/node";

module.exports = async function(request:VercelRequest, response:VercelResponse) {
    const app = new VCLight();
    //在此处添加插件
    await app.fetch(request, response);
};
import VCLight from "vclight";
import { VercelRequest, VercelResponse } from "@vercel/node";

module.exports = async function(request:VercelRequest, response:VercelResponse) {
    const app = new VCLight();
    //在此处添加插件
    await app.fetch(request, response);
};

路由流量

接下来,你需要在根目录新建 vercel.json 文件以配置 vercel 的行为,使得所有请求都经过这个云函数:

json
{
  "builds": [
    {
      "src": "src/*",
      "use": "@vercel/node"
    }
  ],
  "routes": [
    {
      "src": "/(.*)",
      "dest": "src/main.ts"
    }
  ]
}
{
  "builds": [
    {
      "src": "src/*",
      "use": "@vercel/node"
    }
  ],
  "routes": [
    {
      "src": "/(.*)",
      "dest": "src/main.ts"
    }
  ]
}

至此,一个空白项目已经搭建好了。你可以在本地调试或者上传到云端。

INFO

现在的应用在访问时会报错,因为我们还没有为其处理请求并响应。在下一个章节,你将学会如何创建一个插件来响应请求。

使用 VCLight Cli 开始

安装依赖

首先,你需要安装 VCLight Cli。我们建议你全局安装这个包。

shell
$ npm install -g vclight-cli
$ npm install -g vclight-cli
shell
$ yarn global add vclight-cli
$ yarn global add vclight-cli
shell
$ pnpm -g add vclight-cli
$ pnpm -g add vclight-cli

创建项目

shell
$ vclight create $projectName
$ vclight create $projectName

你需要将 $projectName 替换为你需要创建的项目名称。

本地调试

你可以使用以下命令在本地调试你的应用:

shell
$ npx vercel dev
$ npx vercel dev

TIP

你可以将调试指令添加到 package.json 中以使其更加方便:

json
"scripts": {
  "dev": "vercel dev"
},
"scripts": {
  "dev": "vercel dev"
},

如果你已经将调试指令添加到 package.json 中了(模板项目默认添加),你可以使用以下指令更加便捷的调试:

shell
$ npm run serve
$ npm run serve
shell
$ yarn run serve
$ yarn run serve
shell
$ pnpm run serve
$ pnpm run serve

Released under the MIT License.