Linux開発環境セットアップ

警告

このドキュメントは開発環境専用であり、デプロイメントや使用には推奨されません。

前提条件

開発環境要件：

• 機能するPostgreSQLデータベース
• Python環境がインストール済み（Python 3.10推奨）
• poetryをインストール（Python依存関係管理ツール）
• nb-cliをインストール（NoneBotスキャフォールディングツール）

pip install poetry
pip install nb-cli

ソースコードデプロイメント

1. リポジトリをクローン

git clone https://github.com/KroMiose/nekro-agent.git

2. 依存関係をインストール

cd nekro-agent
pip install poetry  # 最初にPython環境をインストールする必要があります：Python 3.10推奨
poetry config virtualenvs.in-project true  # プロジェクトディレクトリに仮想環境をインストール（オプション）
poetry install

3. 設定ファイルを生成

Botを一度実行してプラグインをロードし、設定ファイルを生成するために閉じます：

nb run

4. 必要な情報を設定

設定ファイル./data/configs/nekro-agent.yamlを編集して、データベース接続やその他の情報を設定します。

# Botと管理情報
SUPER_USERS: # 管理者ユーザーQQ番号のリスト
  - "12345678"
BOT_QQ: "12345678" # Bot QQ番号（**必須**）
ADMIN_CHAT_KEY: group_12345678 # 管理者セッションチャネル識別子

# PostgreSQLデータベース設定
POSTGRES_HOST: 127.0.0.1
POSTGRES_PORT: 5432
POSTGRES_USER: db_username
POSTGRES_PASSWORD: db_password
POSTGRES_DATABASE: nekro_agent

完全な設定

完全な設定手順については、config.pyを参照してください

5. サンドボックスイメージをプル

サンドボックス環境用のDockerイメージをプルします：

sudo bash sandbox.sh --pull

イメージ内の依存関係パッケージを変更する必要がある場合は、sandbox/dockerfileとsandbox/pyproject.tomlファイルを変更し、sudo bash sandbox.sh --buildを使用してイメージを再構築できます

6. Botを実行

注意

プラグインは実行中にDockerを動的に使用してサンドボックス実行環境を作成し、コンテナ共有ディレクトリの権限を設定するため、現在のユーザーをdockerグループに追加し、シェルを再起動して変更を有効にすることをお勧めします

sudo usermod -aG docker $USER

nb run
# 開発デバッグモードでリロード監視を有効にし、動的拡張ディレクトリを除外
nb run --reload --reload-excludes ext_workdir

7. OneBot設定

任意のOneBotプロトコルクライアントを使用してBotにログインし、リバースWebSocket接続方法を使用して、接続アドレスを設定します：

ws://127.0.0.1:8021/onebot/v11/ws

TIP

ここでのポートは.env.prodで設定できます。デフォルトは8021です

8. デバッグモード

プロジェクトには.vscode/launch.jsonファイルが含まれており、VSCodeの組み込みデバッグ起動設定を使用して直接デバッグできます。

フロントエンド開発（オプション）

フロントエンドページを開発する必要がある場合は、以下の手順に従ってください：

1. Node.jsをインストール

nvm（Node Version Manager）を使用してNode.jsバージョンを管理することをお勧めします。

1. nvmをインストール：

   curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash

2. インストール後、プロンプトに従ってシェル設定ファイル（例：~/.bashrc、~/.zshrc）にnvm読み込みコマンドを追加し、ターミナルを再起動します。
3. Node.js 20をインストール：

   nvm install 20
   nvm use 20

   システムのパッケージマネージャーからインストールすることもできますが、バージョンが20.xであることを確認してください。

2. pnpmを設定

# pnpmをグローバルにインストール
npm install -g pnpm

# ミラーを設定して加速
pnpm config set registry https://registry.npmmirror.com

3. フロントエンド依存関係をインストール

cd frontend

# 依存関係をインストール
pnpm install --frozen-lockfile

4. フロントエンドを開始

cd ./frontend
pnpm dev

以下のログが表示されたら、ブラウザでアクセスできます：

VITE vx.x.x  ready in xxx ms

➜  Local:   http://localhost:xxxx/ <- これがポート番号です
➜  Network: use --host to expose
➜  press h + enter to show help