Kotoba 项目教程

Kotoba 项目教程

kotoba A Discord bot for helping with learning Japanese. 项目地址: https://gitcode.com/gh_mirrors/ko/kotoba

1. 项目目录结构及介绍

Kotoba 项目包含多个子项目和目录，以下是主要目录结构的介绍：

kotoba/
├── bot/
├── kotobaweb/
│   ├── api/
│   └── frontend/
├── common/
├── node-common/
├── nginx/
├── backup/
├── worker/
├── cloud_functions/
└── resources/

目录介绍：

• bot/：包含 Discord 机器人的代码。
• kotobaweb/：包含 Kotobaweb 的前端和后端代码。
  • api/：Kotobaweb 的 API 代码。
  • frontend/：Kotobaweb 的前端代码（React）。
• common/：包含在 Node 进程和浏览器之间共享的通用代码。
• node-common/：包含仅在 Node 进程之间共享的通用代码。
• nginx/：包含 Nginx 配置文件，用于代理 HTTP 请求到前端和 API。
• backup/：包含备份用户数据到 Google Cloud Storage 的工具。
• worker/：包含一个工作进程，用于处理其他进程中不应阻塞事件循环的重负载任务。
• cloud_functions/：包含可部署为云函数的 HTTP 端点代码，某些机器人命令依赖于此。
• resources/：包含字典、字体、图像和其他非代码资产。

2. 项目启动文件介绍

Discord 机器人启动

1. 安装 MongoDB 并启动它，默认端口为 27017。
2. 进入 node-common 目录并安装依赖：

   cd /node-common
   npm ci
   

3. 进入 bot 目录并安装依赖：

   cd /bot
   npm ci
   npm run buildresources # 这可能需要几分钟
   npm start
   

KotobaWeb 启动

1. 安装 MongoDB 并启动它，默认端口为 27017。
2. 进入 node-common 目录并安装依赖：

   cd /node-common
   npm ci
   

3. 进入 api 目录并启动 API：

   cd /api
   npm ci
   npm run buildresources # 这可能需要几分钟
   npm start
   

4. 进入 kotobaweb 目录并启动前端：

   cd /kotobaweb
   npm ci
   npm start
   

Worker 进程启动

1. 进入 worker 目录并启动工作进程：

   cd /worker
   npm ci
   npm start
   

3. 项目配置文件介绍

在克隆仓库后，需要配置 config/config_sample.js 文件并将其重命名为 config.js。大多数配置是可选的，但某些功能可能无法正常工作或完全不可用，如果未配置这些选项。

配置文件示例

module.exports = {
  // 数据库连接字符串
  mongoUrl: 'mongodb://localhost:27017/kotoba',
  
  // Discord 机器人令牌
  discordToken: 'YOUR_DISCORD_BOT_TOKEN',
  
  // 其他配置选项...
};

配置选项

• mongoUrl：MongoDB 数据库连接字符串。
• discordToken：Discord 机器人令牌。
• 其他配置选项：根据需要配置其他选项，如云函数 URL、字体路径等。

通过以上步骤，您可以成功启动并配置 Kotoba 项目。

kotoba A Discord bot for helping with learning Japanese. 项目地址: https://gitcode.com/gh_mirrors/ko/kotoba