🎯 このガイドについて
このガイドでは、Conference App(学会大会管理システム)をゼロからセットアップする手順を説明します。
所要時間: 約15分(初回のみ)
✅ セットアップ完了後にできること
- 学会大会情報の登録・管理
- セッション(口頭発表・ポスター等)の管理
- 参加者登録・認証機能の利用
- REST APIを使った外部連携
📋 事前準備
必要な環境
| 項目 | 要件 | 備考 |
|---|---|---|
| OS | Windows 10/11, macOS, Linux | 64bit版推奨 |
| Docker Desktop | 最新版(4.0以降) | 必須 |
| メモリ | 4GB以上 | 8GB推奨 |
| ディスク空き容量 | 5GB以上 | 10GB推奨 |
| ブラウザ | Chrome, Edge, Firefox, Safari | Chrome推奨 |
⚠️ 重要な注意事項
- Docker Desktopは必須です。インストールされていない場合は、先にインストールしてください。
- Windows Homeエディションの場合、WSL2が有効化されている必要があります。
- 企業ネットワーク環境の場合、プロキシ設定が必要な場合があります。
🚀 セットアップ手順
Docker Desktopのインストール
まだインストールしていない場合は、公式サイトからダウンロードしてインストールします。
インストール手順:
- 上記ボタンから公式サイトにアクセス
- お使いのOSに合わせてインストーラーをダウンロード
- ダウンロードしたファイルを実行
- 画面の指示に従ってインストール
- インストール完了後、PCを再起動
💡 Windows Homeをお使いの方
WSL2(Windows Subsystem for Linux 2)を有効化する必要があります。
Docker Desktopのインストール時に自動的にセットアップされます。
Conference Appのダウンロード
プロジェクトファイル一式を以下のいずれかの方法でダウンロードします。
方法A: ZIPファイルをダウンロード(推奨)
- プロジェクトのZIPファイルをダウンロード
- 任意のフォルダに解凍(例:
C:\Users\kawag\work\) - 解凍後のフォルダ名が
conference-appになっていることを確認
⚠️ 解凍先の注意
- パスに日本語や空白を含まない場所に解凍してください
- 例: ❌
C:\マイドキュメント\Conference App\ - 例: ✅
C:\Users\kawag\work\conference-app\
方法B: Gitでクローン(開発者向け)
git clone https://github.com/your-repo/conference-app.git
cd conference-app
フォルダ構成の確認
解凍したフォルダの中身が以下のようになっているか確認します。
✅ 確認ポイント
docker-compose.ymlファイルが存在するdocker-start.batファイルが存在する(Windows)backend/フォルダが存在する
Docker環境の起動
いよいよアプリケーションを起動します。
Windows の場合:
- Docker Desktopを起動(タスクトレイのアイコンが緑色になるまで待つ)
conference-appフォルダを開くdocker-start.batをダブルクリック- コマンドプロンプトが開き、自動的にセットアップが始まります
Mac / Linux の場合:
cd /path/to/conference-app
docker-compose up -d
✅ 起動成功の確認
以下のメッセージが表示されれば成功です:
======================================
✅ 起動完了
======================================
サービスURL:
- API (Swagger): http://localhost:8000/api/v1/docs
- バックエンド: http://localhost:8000
データベース初期化
初回のみ必要な操作です。 データベースのテーブルを作成します。
Windows の場合:
cd C:\Users\kawag\work\conference-app
docker-compose exec backend bash
alembic upgrade head
exit
Mac / Linux の場合:
cd /path/to/conference-app
docker-compose exec backend bash
alembic upgrade head
exit
💡 この操作で作成されるもの
usersテーブル - ユーザー情報conferencesテーブル - 大会情報sessionsテーブル - セッション情報presentationsテーブル - 発表情報
✅ 成功の確認
以下のようなメッセージが表示されれば成功です:
INFO [alembic.runtime.migration] Running upgrade -> 001, Initial migration: users, conferences, sessions, presentations
動作確認
ブラウザでアプリケーションにアクセスして、正常に動作しているか確認します。
確認手順:
- ブラウザを開く(Chrome推奨)
- 以下のURLにアクセス:
✅ 正常に動作している場合
- Swagger UIの画面が表示される
- 「Conference App API」というタイトルが見える
- 複数のAPIエンドポイントが一覧表示される
追加確認(オプション):
ヘルスチェックエンドポイントにアクセス:
以下のJSONが表示されればOKです:
{
"status": "ok",
"version": "1.0.0"
}
🎉 セットアップ完了!
おめでとうございます!
Conference Appのセットアップが完了しました。
これで学会大会管理システムを使い始めることができます。
次のステップ
- 取り扱い説明書を確認 -
USER_MANUAL.htmlを開いて基本操作を学ぶ - ユーザー登録 - Swagger UIから最初のユーザーを登録
- 大会情報を登録 - テスト用の大会データを作成
- セッションを追加 - 口頭発表やポスターセッションを登録
⚙️ 日常的な使い方
起動方法(2回目以降)
- Docker Desktopを起動
docker-start.batをダブルクリック(Windows)- ブラウザで
http://localhost:8000/api/v1/docsにアクセス
停止方法
docker-stop.batをダブルクリック(Windows)- または:
docker-compose downをコマンドで実行
💡 ヒント
PCを再起動してもデータは保持されます。Docker Desktopを起動して docker-start.bat を実行すれば、前回の続きから使えます。
🔧 トラブルシューティング
問題1: Docker Desktopが起動していない
症状: ❌ エラー: Docker Desktopが起動していません
解決策:
- Docker Desktopアプリケーションを起動
- タスクトレイのDockerアイコンが緑色になるまで待つ(1〜2分)
docker-start.batを再実行
問題2: ポートが既に使用されている
症状: Error: Port 8000 is already in use
解決策:
- 既存のコンテナを停止:
docker-compose down - ポート使用状況を確認:
netstat -ano | findstr :8000(Windows) - 必要に応じて該当プロセスを終了
問題3: マイグレーションエラー
症状: sqlalchemy.exc.OperationalError
解決策:
- PostgreSQLコンテナが起動しているか確認:
docker-compose ps - 少し待ってから再試行(起動に時間がかかる場合あり)
- それでもダメな場合:
docker-compose down -vでボリューム削除後、最初から再実行
💬 サポート
問題が解決しない場合は、以下を確認してください:
- Docker Desktopのバージョンが最新か
- ディスク容量が十分にあるか(5GB以上)
- ファイアウォールやウイルス対策ソフトがDockerをブロックしていないか
それでも解決しない場合は、開発者またはサポート窓口に連絡してください。
📚 関連ドキュメント
- USER_MANUAL.html - 詳細な取り扱い説明書
- QUICKSTART.md - クイックスタートガイド(Markdown版)
- MVP.md - 技術仕様書
- README.md - プロジェクト概要
🎓 学習リソース
- Swagger UI -
http://localhost:8000/api/v1/docsで対話的にAPIを学習 - FastAPI公式ドキュメント - https://fastapi.tiangolo.com/ja/
- Docker公式ドキュメント - https://docs.docker.com/
🚀 さっそく使ってみましょう!
セットアップが完了したら、USER_MANUAL.html を開いて基本操作を学び、実際に大会データを登録してみてください。