Skip to content

BlackDonut/task-manager

Repository files navigation

医療機器国際申請管理システム

注意: 本プロジェクトは学習・技術検証を目的とした 架空のプロジェクト です。 実在する組織・製品・申請データとは一切関係ありません。

製品・申請・タスク・販売国を横断して進捗・遅延を可視化し、医療機器の規制申請業務を支援するシステム。

概要

レイヤー 技術
バックエンド Python 3.12+ / FastAPI
ORM SQLAlchemy (pyodbc)
データベース SQL Server
マイグレーション Alembic
バリデーション Pydantic v2
型チェック mypy (--strict)
リンター Ruff
テスト pytest + pytest-asyncio
ログ structlog

設計方針: API ファースト / 3 レイヤーアーキテクチャ(Router → Service → Repository)

最初の3ステップ

  1. CONTRIBUTING.md を読んで、開発フローと禁止事項を把握する。
  2. .github/instructions/ai-onboarding.instructions.md を読んで、GitHub Copilot の使い分けを把握する。
  3. docs/guides/first-feature-tutorial.md を開いて、最初の 1 機能をその通りに進める。

ドキュメント

仕様の Single Source of Truth は docs/ です。

パス 内容
docs/requirements/ 要件定義
docs/design/ 設計書(基本設計・詳細設計・DB)
docs/flows/ フロー設計
docs/guides/ 開発ガイド
docs/decisions/ 設計判断記録 (ADR)
docs/reviews/ アーキテクチャレビュー記録

docs/guides/ の主要ファイル

ファイル 内容
development.md セットアップ・開発コマンド・CI
code-review-checklist.md コードレビューチェックリスト(SSOT)
first-feature-tutorial.md 最初の機能を作るチュートリアル
glossary.md ドメイン用語・技術用語の定義
test-plan.md テスト計画・テスト種別と範囲

.github/ — AI 駆動開発の設定

  • .github/GUIDE.md: チーム開発ガイド(人間向け・AI ツール利用法)
  • .github/copilot-instructions.md: Copilot 用ルール設定(AI 自動読み込み)
  • .github/instructions/: タスク別手順書(AI 向けが中心・人間も必要時参照)
  • .github/agents/: AI エージェント定義
  • .github/prompts/: 再利用可能プロンプト(/scaffold 等)
  • .github/skills/: AI 専門知識モジュール
  • .github/hooks/: Copilot 安全フック設定(危険操作の抑止など)
  • CHANGELOG.md: 変更履歴(プロジェクト全体 + .github/ 規約)

ドキュメントの整備順序は docs/guides/development.md「ドキュメント整備ロードマップ」を参照してください。

クイックスタート

前提条件: Python 3.12 以上・SQL Server が起動済みであること。 初回セットアップの詳細(Docker・環境変数設定を含む)は docs/guides/development.md を参照してください。

python -m venv .venv          # 仮想環境作成(初回のみ)
source .venv/bin/activate     # 仮想環境有効化(Windows: .venv\Scripts\activate)
pip install -e ".[dev]"       # 依存パッケージをインストール(初回のみ)
uvicorn app.main:app --reload # 開発サーバー起動 (port 8000)

起動後、ブラウザで http://localhost:8000/docs を開いてください(Swagger UI)。

全コマンド(テスト・Lint・Alembic 等)は docs/guides/development.md を参照してください。

プロジェクト構成

task-manager/
├── .github/              # Copilot instructions・ワークフロー設定
├── docs/                 # 仕様・設計書(要件・設計・ADR・ガイド等)
├── scripts/              # L1/L2 パターンチェックスクリプト
└── azure-pipelines.yml   # CI パイプライン定義(TFS Gated Check-in)

実装フェーズ以降の構成予定

task-manager/
├── app/
│   ├── core/         # 共通基盤(auth, database, result, clock, middleware)
│   ├── features/     # 機能モジュール(各機能に router/service/repository/models/schemas)
│   └── main.py       # FastAPI アプリケーションエントリーポイント
├── tests/            # テスト(features/ のミラー構造)
├── alembic/          # Alembic マイグレーション
└── pyproject.toml    # プロジェクト設定・依存定義

コントリビューション

本プロジェクトへの参加方法は CONTRIBUTING.md を参照してください。

ライセンス

Private

About

No description, website, or topics provided.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors