VirtualLiveLab / Mikubot

A Discord bot for VirtualLiveLab
3 stars 0 forks source link
discord-py python

MikuBot

A Discord bot for VirtualLiveLab

ローカル開発

リポジトリをクローン

  gh repo clone VirtualLiveLab/Mikubot

プロジェクトへ移動

  cd Mikubot

開発環境をセットアップ

  rye sync

.envをコピー

  cp .env.example .env

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

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

開発サーバーを起動

  rye run dev

[!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

最小構成の.envの例

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

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

NOTION_TOKEN=""
NOTION_DOMAIN=""

SENTRY_DSN=""

開発の流れ

  1. 取り組む内容をIssueにする or 既にあるIssueを選ぶ
  2. Issueに自分をAssignする
  3. stagingブランチから新しいブランチを切る
  4. Issueの内容を実装する
  5. stagingブランチにPRを出す
  6. レビューを受けて問題がなければマージする
  7. stagingブランチでデプロイして、正しく動作するか確認する
  8. 問題がなければmainブランチにPRを出してマージする