メインコンテンツまでスキップ

シーダー (Seeder)

このドキュメントでは、Geekleのシーディングツールを使用してデータベースを初期化し、初期データを投入する方法や、不要になったデータをクリアする方法について説明します。

前提条件​

  • Geekleの既存のデプロイメント。
  • @basaldev パッケージに対する読み取り権限を持つNodeblocks NPMトークン。
  • Node.js 18.x以降。
  • （推奨）VSCode。
  • MongoDB接続文字列（ローカル開発 を参照）。

シーダーの実行​

  1. リポジトリをクローンします。

  2. 依存関係をインストールします。

nvm use
yarn
  1. リポジトリのルートに .env ファイルをデフォルトの .env.example ファイルから作成します。必要な環境変数（通常はStripe APIキーとMongoDB接続文字列）を入力します。

次のコマンドを実行してシーダーを実行します。

yarn seeder list users

すべてのデマンドユーザーのリストが表示された場合、シーダーの設定は成功です。

重要なコマンド​

  • yarn seeder insert skills - スキルをデータベースに挿入します。これはアプリケーションの動作に必要です。スキルなしではデマンドユーザーを作成できません。
  • yarn seeder insert admin 1 <メールアドレス> - 指定したメールアドレスを持つ管理者ユーザーを作成します。

追加のコマンド​

利用可能なコマンドの一覧を確認し、新しいコマンドを作成するには、リポジトリをVSCodeで開きます。

code .vscode/geekle-seeder.code-workspace

利用可能なコマンドとその実装については、src/commands/index.ts ファイルを確認してください。

新しいコマンドを作成するには、src/commands/<data-type> ディレクトリ内に新しいファイルを作成するか、既存のファイルを更新します。コマンドはバックエンドサービスパッケージを使用して実装されており、バックエンドのデータサービスを使用してデータベース内のデータを作成または更新できます。

既存のコマンドを読んで、どのように動作するか理解し、開発やテストのニーズに合わせて新しいコマンドを作成することをお勧めします。