コードの実行

前提条件

Node.js >= 22.12.0（nvmまたはfnmを推奨）
Yarn 4.x — Corepackで有効化：

corepack enable

推奨IDEプラグイン（VS Code）：

ドキュメントサイト (findadoc-docs)

クローンとインストール

git clone https://github.com/ourjapanlife/findadoc-docs.git
cd findadoc-docs
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

開発サーバーの起動

zensical serve

サイトは http://127.0.0.1:8000 で利用できます。

ビルド

zensical build --clean

フロントエンド (findadoc-web)

クローンとインストール

git clone https://github.com/ourjapanlife/findadoc-web.git
cd findadoc-web
yarn install

Gitフックの設定

yarn prepare

Huskyを設定し、コミット前にリンティングを自動実行します。

開発サーバーの起動

yarn dev

サイトは http://localhost:3000 で利用できます。

ローカルAPIとの接続

ローカルで実行中のバックエンドに接続する場合：

yarn dev:localserver

モデレーションダッシュボード

モデレーションダッシュボードにはローカルで実行中のバックエンドが必要です：

バックエンドを起動する（下記のバックエンドセクションを参照）
ローカルAPI用にフロントエンドを起動：yarn dev:localserver
http://localhost:3000/login にアクセス
ユーザー名とパスワードを入力 — 認証情報はSlackでコアメンテナーに連絡してください

GraphQL型の生成

GraphQL APIのTypeScript型は自動生成されます。新しい変更をプルした後やAPIスキーマが更新された場合に実行してください：

yarn generate

gqlTypes.tsファイルが生成されます。追加のカスタムTypeScript型は./typedefsフォルダに配置してください。

リンティング

yarn lint        # 問題をチェック
yarn lint:fix    # 問題を自動修正

テスト

# ユニットテスト
yarn test:unit

# E2Eテスト（Cypress GUIを開く）
yarn test:e2e

# E2Eテスト（ヘッドレス）
yarn test:e2e:headless

Storybook

yarn storybook

Storybookは http://localhost:6006 で利用できます。

プロダクションビルド

yarn prod:build

バックエンド (findadoc-server)

Note

バックエンドにはDockerとSupabase CLIが必要です。

クローンとインストール

git clone https://github.com/ourjapanlife/findadoc-server.git
cd findadoc-server
yarn install

開発サーバーの起動

Supabaseの起動、データベースのシード、型の生成、開発サーバーの起動を行います：

yarn dev

デバッグ

VS Codeでバックエンドをデバッグできます：Run and Debugタブを開き、JavaScript Debug Terminalを選択し、そのターミナルでyarn devを実行してください。デバッガーが自動的に接続されます — 行番号をクリックしてブレークポイントを追加するだけです。

Apollo Explorerでのテスト

サーバーが http://localhost:4000 で実行中の場合：

メニューからExplorerセクションに移動
「Root Types」の下にあるquery: Queryをクリック
+ボタンをクリックして利用可能なフィールドを表示
フィールドを選択してクエリビルダーに追加
IDが必要な型（例：FacilityやHealthcareProfessional）の場合、VariablesウィンドウにIDを文字列として追加

テスト

yarn test

リンティング

yarn lint

MCPサーバー (findadoc-mcp)

クローンとインストール

git clone https://github.com/ourjapanlife/findadoc-mcp.git
cd findadoc-mcp
yarn install

開発

yarn dev

ビルド

yarn build

テスト

yarn test
yarn test:watch