README.md

MikuBot

A Discord bot for VirtualLiveLab

ローカル開発

事前準備

1. このドキュメント を参考にgo-task をインストールしておくこと。
2. このドキュメント を参考にuv をインストールしておくこと。

環境構築

リポジトリをクローン

  gh repo clone VirtualLiveLab/Mikubot

プロジェクトへ移動

  cd Mikubot

開発環境をセットアップ

  task setup

Environment Variablesを参照して.envファイルに環境変数を設定する

Warning

.env.exampleを編集するわけではないことに注意。 .envファイルを編集すること。

ローカル環境でBotを起動

  task up

Tip

この開発サーバーはファイルを変更したら一度再起動しないと変更が反映されない。

Environment Variables

ないと起動しないもの

DISCORD_BOT_TOKEN: Discord Developer Portalから取得したBotのトークン

なくても起動するもの

LOG_CHANNEL_ID: ログメッセージを送るチャンネルのID。ない場合はログを送信しない。

NOTION_TOKEN: Notion Integrationのトークン。Notion APIを使用するために必要。

NOTION_DOMAIN: Notionワークスペースのドメイン。ここで設定したドメインのNotion Urlが送信されると検知される。

SENTRY_DSN: 開発時は変更しなくてOK

DEPLOY_ENVIRONMENT: 開発時は変更しなくてOK

CF_ACCESS_CLIENT_ID, CF_ACCESS_CLIENT_SECRET: Cloudflare AccessのクライアントIDとクライアントシークレット。/wol による部室PC遠隔起動に必要。

最小構成の.envの例

# 必ずセットするもの
DISCORD_BOT_TOKEN="Discord Bot Token Here"

# なくても起動するもの
LOG_CHANNEL_ID=""

NOTION_TOKEN=""
NOTION_DOMAIN=""

SENTRY_DSN=""

# PC遠隔起動機能
CF_ACCESS_CLIENT_ID=""
CF_ACCESS_CLIENT_SECRET=""