happa ドキュメント¶

happa (旧: TARF) は大学祭などのイベント管理システムです。

📚 ドキュメント構成¶

🚀 はじめに¶

システム概要 - happaシステムの全体像
クイックスタート - 5分で始める開発環境セットアップ

📖 API仕様¶

API仕様書 - 全APIエンドポイントの詳細仕様
認証・認可 - Auth0とリソースレベル権限システム

🔐 権限管理¶

リソースレベル権限システム - 新しい権限システムの概要
使用例集 - 17の実践的な使用例
移行ガイド - 既存システムからの移行手順

💻 開発ガイド¶

Web フロントエンド - Next.js アプリケーション
FastAPI バックエンド - Python APIサーバー
統合ガイド - Web ↔ FastAPI の連携

🗄️ データベース¶

データモデル - Prisma スキーマとエンティティ
マイグレーション - データベース変更の管理

📦 デプロイメント¶

デプロイガイド - 本番環境へのデプロイ手順

🎯 機能別ガイド¶

ファイルアップロード - 画像・文書のアップロード
ファイルバージョン管理 - バージョン管理と承認フロー
企画申請フロー - 企画の申請と承認

🏗️ アーキテクチャ¶

┌─────────────────┐
│   Web (Next.js) │ ← Cloudflare Pages
│   + Hono API    │
└────────┬────────┘
         │
         ├─ Auth0 (認証)
         ├─ MySQL (データベース)
         └─ Cloudflare R2 (ファイルストレージ)

┌─────────────────┐
│ API (FastAPI)   │ ← オプション (将来の分離用)
└─────────────────┘

🤝 コントリビューション¶

開発環境のセットアップ¶

リポジトリのクローン

git clone https://github.com/your-org/happa.git
cd happa

依存関係のインストール
```
cd web
npm install --legacy-peer-deps
```

環境変数の設定

cp .env.example .env
# .envファイルを編集

データベースのセットアップ

npx prisma migrate dev
npx tsx prisma/seed-resource-roles.ts

開発サーバーの起動
```
npm run dev
```

コーディング規約¶

TypeScript を使用
ESLint/Prettier でコードフォーマット
コミットメッセージは Conventional Commits に従う

📝 ライセンス¶

このプロジェクトのライセンス情報については、プロジェクトルートの LICENSE ファイルを参照してください。

🆘 サポート¶

問題が発生した場合: 1. FAQ を確認 2. トラブルシューティングを参照 3. GitHub Issues で報告

最終更新: 2026-01-07