# 快速上手

# 环境初始化

Twikoo 使用云开发作为评论后台,每个云开发用户均长期享受1个免费的标准型基础版1资源套餐。如果您已经拥有了一个免费版云开发环境,在环境配置符合要求的情况下,Twikoo 理论可以与其他项目共用一个环境。

  1. 注册云开发CloudBase (opens new window)
  2. 进入云开发控制台 (opens new window),新建环境,请按个人需要配置环境

提示

  • 推荐选择计费方式包年包月,套餐版本基础班 1
  • 如果提示“选择部署应用”,请选择“不创建环境”
  1. 进入环境-登录授权 (opens new window),启用“匿名登录”
  2. 进入环境-安全配置 (opens new window),将网站域名添加到“WEB安全域名”
  3. 复制环境Id备用

# 环境部署

注意

  • 请确保您已经安装了 Node.js (opens new window)
  • 请将命令、代码中“您的环境id”替换为您自己的环境id
  • 请不要使用 Windows 自带的记事本编辑 envId.txt,否则会部署失败,后续会修复该问题
  1. 克隆本仓库
git clone https://github.com/imaegoo/twikoo.git
cd twikoo

如果您没有安装 Git,也可以从 Release (opens new window) 页面下载最新的 Source code

  1. 安装依赖项
npm install # 或 yarn install
  1. 设置环境id
echo 您的环境id > envId.txt
  1. 授权云开发环境
npm run login # 或 yarn run login
  1. 自动部署
npm run deploy # 或 yarn deploy

更新 Twikoo 版本时,请再次执行此命令更新现有的云函数

# 使用

# 通过 CDN 引入

<div id="twikoo"></div>
<script src="https://cdn.jsdelivr.net/npm/twikoo@0.1.15/dist/twikoo.all.min.js"></script>
<script>twikoo.init({ envId: '您的环境id' })</script>

# 通过 NPM 引入

npm install twikoo # 或 yarn add twikoo
<div id="twikoo"></div>
import twikoo from 'twikoo' // 或 const twikoo = require('twikoo')
twikoo.init({ envId: '您的环境id' })
Last Updated: 10/30/2020, 3:22:15 AM