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

JCLO 開発ドキュメント

JCLO(Japan Circuit Ladies Organization)公式ウェブサイトの社内向け設計・運用ドキュメント。

:::warning 取り扱い注意 このサイトは社内向けであり、一般公開してはいけません。要件定義・セキュリティ設計・ 個人情報の取り扱いなど機密情報を含みます。ローカルでの閲覧(pnpm start)を基本とし、 ホスティングする場合は必ず認証の裏に置いてください。 :::

このサイトについて

  • 本番アプリ(リポジトリルートの Next.js)とは完全に独立した Docusaurus プロジェクト(docs-site/)です。本番ビルド・デプロイには一切含まれません。
  • 内容は原則 as-built(実装の現状) を反映します。コードを変更したら、対応するドキュメントも更新してください。

ドキュメント構成

カテゴリ内容
概要プロジェクト概要、アプリケーションアーキテクチャ、技術構成
画面設計全画面の一覧と、機能エリアごとの画面設計
データモデルデータモデル概要・リレーション・テーブル定義
API 仕様API ルートの仕様
機能・フロー設計認証・認可、会員登録、エントリー・決済、メール、外部連携、ユーザー移行 など
運用・インフラ手順環境構築、デプロイ、ドメイン切り替え、環境変数、運用 SQL
要件定義要件定義書
テストテスト項目一覧・優先度・テストレポート
アーカイブ特定時点のレビュー記録・未実装項目メモ

左のサイドバーから各ドキュメントを参照してください。

ローカルでの起動

cd docs-site
pnpm install
pnpm start

ブラウザで http://localhost:3001 が開きます(本番アプリの pnpm dev はポート 3000 なので競合しません)。