# 快速开始

如果你想在某个网页或者文章页中使用 Waline,请参照以下步骤配置

# 获取APP ID 和 APP Key

请先登录 (opens new window)注册 (opens new window) LeanCloud 国际版, 进入控制台 (opens new window)后点击左下角创建应用 (opens new window)

应用创建好以后,进入刚刚创建的应用,选择左下角的设置>应用Key,然后就能看到你的APP ID,APP KeyMaster Key了:

注:
这里推荐使用 Leancloud 国际版。如果你确实想用 Leancloud 国内版的话(国际版是 leancloud.app (opens new window),非国际版是 leancloud.cn (opens new window)),除了 APP_ID, APP_KeyMaster Key 之外,还需要对应用进行域名绑定。
进入应用后选择 设置 > 域名绑定 > API 访问域名 绑定新域名 > 输入需要绑定的已备案域名点击 确定。之后按照页面上的提示去 DNS 上做正确的 CNAME 解析即可。

# Vercel 部署

(opens new window)

点击上方按钮,跳转至 Vercel 进行快速部署。未登录的话需要登录,这里选 Github 登录即可。登录后会让你输入 Vercel 项目名称。

输入名称后点击 Continue 进入下一步,输入 Github 仓库名称。Vercel 会基于 waline 模板帮助你新建并初始化该仓库。

仓库初始化完毕后开始准备部署到 Vercel。这里需要在 Environment Variables 初配置 LEAN_ID, LEAN_KEYLEAN_MASTER_KEY 三个环境变量。它们的值分别对应上一步在 LeanCloud 中获得的 APP ID, APP KEY, Master Key。如果你是 LeanCloud 国内版用户的话,还需要输入 LEAN_SERVER 环境变量,对应的是你在上一步上绑定的已备案域名。

点击 Deploy 就会开始进行部署了。稍等片刻,就会看到满屏的烟花庆祝你部署成功了。点击 Visit 会跳转到部署好的网站地址上,该地址即为之后需要填入的 serverURL 地址。

# HTML 片段

修改初始化对象中的 serverURL 的值为上面刚刚获取到的二级域名即可(其他可以默认)。

<head>
  ..
  <script src='//cdn.jsdelivr.net/npm/@waline/client/dist/Waline.min.js'></script>
  ...
</head>
<body>
  ...
  <div id="waline"></div>
  <script>
    new Waline({
      el: '#waline',
      path: location.pathname,
      serverURL: 'https://your-domain.vercel.app'
    });
  </script>
</body>

# 配置

修改初始化对象中的 serverURL 的值为上面刚刚获取到的二级域名即可(其他可以默认)。

new Waline({
  el: '#waline',
  path: location.pathname
});

# NPM

Waline 已发布到npm (opens new window),可以直接用命令安装:

# Install waline
npm install @waline/client --save-dev
// Use import
import Waline from '@waline/client';
// or Use require
const Waline = require('@waline/client');

new Waline({
  el:'#waline',
  // other config
})

# 评论数据管理

Waline 还带有简单的后台,可以实现对评论的管理。部署完成后访问 <serverURL>/ui/register 进行注册,第一个注册的你会被设定成管理员。登录成功后就可以看到评论管理的界面了,大家可以收藏该地址方便后续使用。