https://github.com/hanshino/redive_linebot
基於 Bottender 框架實作出的，公主連結聊天機器人，附加其他實用管理功能。
https://github.com/hanshino/redive_linebot
bottender chatbot docker-compose linebot node-js princess-connect-redive
Last synced: about 1 year ago
JSON representation
基於 Bottender 框架實作出的，公主連結聊天機器人，附加其他實用管理功能。
- Host: GitHub
- URL: https://github.com/hanshino/redive_linebot
- Owner: hanshino
- License: mit
- Created: 2020-07-06T08:43:37.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-29T02:12:53.000Z (about 1 year ago)
- Last Synced: 2025-04-29T21:13:16.935Z (about 1 year ago)
- Topics: bottender, chatbot, docker-compose, linebot, node-js, princess-connect-redive
- Language: JavaScript
- Homepage: https://liff.line.me/1654464491-YNenGe96
- Size: 27.6 MB
- Stars: 23
- Watchers: 2
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 公主連結聊天機器人
本專案是基於框架[bottender](https://bottender.js.org/)進行實作，此框架特色
- 適用於多種臺灣常用聊天 app ~~雖然我都沒有好友，只好寫機器人陪我聊天~~
- 框架已處理好不同平台的規則，無須因應各平台進行適應
- 開發過程協助分析每一動作的耗時，進行效能優化
- 因為他真的超好用 der
## 目錄
- [公主連結聊天機器人](#公主連結聊天機器人)
- [目錄](#目錄)
- [使用須知](#使用須知)
- [機器配置](#機器配置)
- [Production](#production)
- [Developement](#developement)
- [目前適用聊天軟體](#目前適用聊天軟體)
- [此專案特色](#此專案特色)
- [各大遊戲性功能 - 管理員用](#各大遊戲性功能---管理員用)
- [群組功能性 - 使用者用](#群組功能性---使用者用)
- [公主連結資訊查詢 - 使用者](#公主連結資訊查詢---使用者)
- [部分截圖](#部分截圖)
- [事前準備](#事前準備)
- [安裝方式](#安裝方式)
- [前置作業](#前置作業)
- [正式用](#正式用)
- [開發用](#開發用)
- [額外教學 (ngrok)](#額外教學-ngrok)
- [Line 後臺設定](#line後臺設定)
- [注意事項](#注意事項)
## 使用須知
本專案已配置好所有程式所需之環境，只需跟著[安裝方式](#安裝方式)，進行操作即可。
## 機器配置
此專案結合了 `docker-compose` 一鍵佈署的特性，以下為使用到的服務
### Production
| container | image | expose | 說明 |
| ---------- | -------------------------------------------------------------------------------------- | ------ | ------------------------------------- |
| nginx | [nginx](https://hub.docker.com/_/nginx) | 80 | `webserver` |
| frontend | [frontend](https://github.com/hanshino/redive_linebot/blob/master/frontend/Dockerfile) | 80 | `react-frontend` |
| bot | [app](https://github.com/hanshino/redive_linebot/blob/master/app/Dockerfile) | 5000 | `node:lts-bullseye-slim` 包含主程式 |
| mysql | [mysql](https://hub.docker.com/_/mysql) | 3306 | 資料庫 |
| redis | [redis](https://hub.docker.com/_/redis) | 6379 | 記憶體快取資料庫 |
| crontab | [crontab](https://github.com/hanshino/redive_linebot/blob/master/job/Dockerfile) | | `node:lts-bullseye-slim` 定時排程執行 |
| phpmyadmin | [phpmyadmin](https://hub.docker.com/r/phpmyadmin/phpmyadmin/) | 80 | `phpmyadmin` 資料庫管理 |
可使用`docker-compose`指令水平擴展主程式，端看於個人硬體強度來做提升。
### Developement
開發用，將可編輯的程式掛載至容器，編輯則馬上生效
- `frontend` 採用 `react-scripts` 的 開發環境建置
- `bot` 以及 `crontab` 採用 `nodemon`
| container | image | expose | 說明 |
| ---------- | -------------------------------------------------------------------------------------- | ------ | -------------------------------- |
| nginx | [nginx](https://hub.docker.com/_/nginx) | 5000 | `webserver` |
| frontend | [frontend](https://github.com/hanshino/redive_linebot/blob/master/frontend/Dockerfile) | 3000 | `react-frontend` |
| bot | [app](https://github.com/hanshino/redive_linebot/blob/master/app/Dockerfile) | 5000 | `node.js:12-alpine` 包含主程式 |
| mysql | [mysql](https://hub.docker.com/_/mysql) | 3306 | 資料庫 |
| redis | [redis](https://hub.docker.com/_/redis) | 6379 | 記憶體快取資料庫 |
| crontab | [crontab](https://github.com/hanshino/redive_linebot/blob/master/job/Dockerfile) | | `node.js:12-alpine` 定時排程執行 |
| phpmyadmin | [phpmyadmin](https://hub.docker.com/r/phpmyadmin/phpmyadmin/) | 8080 | `phpmyadmin` 資料庫管理 |
## 目前適用聊天軟體
- [Line](https://line.me/zh-hant/)
## 此專案特色
### 各大遊戲性功能 - 管理員用
- 抽卡模擬
- 資訊查詢（管理員自主設定指令）
### 群組功能性 - 使用者用
- 群組排行
- 群組設定（自定義功能開關）
- 等級系統
### 公主連結資訊查詢 - 使用者
- 角色資訊查詢
- 戰隊報名管理
- 官方活動查詢
## 部分截圖
## 事前準備
- [Git](https://git-scm.com/)
- [Docker](https://www.docker.com/)
- [Line 機器人申請](https://manager.line.biz/)，記下 Access Token & Client Secret
## 安裝方式
### 前置作業
1. 打開你的 CLI 跟著我一起輸入(終端機、命令提示字元、命令介面)
2. 將專案下載到你的電腦
`git clone https://github.com/hanshino/redive_linebot.git`
3. 進入專案資料夾
`cd redive_linebot`
4. 複製環境變數範本
`cp .env.example .env`
5. 配置環境變數
編輯 `.env` ，請務必填上所有資訊並存檔！
6. 建立 `docker` 環境
`make build-images`
7. 安裝專案所需套件
`make build-project`
### 啟動專案
1. `docker-compose up -d`
2. 此時電腦的 **5000 port** 將會開啟服務，如無固定 ip 可用，可使用[ngrok](https://ngrok.com/)進行服務公開。
### 額外教學 (ngrok)
1. 下載[ngrok](https://ngrok.com/)
2. 請在有`ngrok`的目錄下輸入 `ngrok http 80 --region ap` or `ngrok http 5000 --region ap`
3. 請將網址 ex: https://xxxxxxxxxx.ap.ngrok.io/webhooks/line 複製，繼續後續動作
### Line 後臺設定
1. 網址預設為 `https://{your_domain}/webhooks/line`
2. 將網址填進 [Line Account Manager](https://manager.line.biz/)
## 注意事項
- 要使用戰隊功能，需先跟 [Ian 戰隊系統作者](https://discord.gg/cwFc4qh)申請 Accesss Token
- `Windows` 作業系統使用 `Docker` 需注意開啟 `hyper-v` 是否會影響自己遊玩手機模擬器。
- 初次啟動時需耗時一段時間進行環境建置，此屬正常情況！