📦 Conference App

ダウンロード・セットアップガイド

バージョン MVP 1.0

🎯 このガイドについて

このガイドでは、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が有効化されている必要があります。
  • 企業ネットワーク環境の場合、プロキシ設定が必要な場合があります。

🚀 セットアップ手順

1

Docker Desktopのインストール

まだインストールしていない場合は、公式サイトからダウンロードしてインストールします。

インストール手順:

  1. 上記ボタンから公式サイトにアクセス
  2. お使いのOSに合わせてインストーラーをダウンロード
  3. ダウンロードしたファイルを実行
  4. 画面の指示に従ってインストール
  5. インストール完了後、PCを再起動

💡 Windows Homeをお使いの方

WSL2(Windows Subsystem for Linux 2)を有効化する必要があります。

Docker Desktopのインストール時に自動的にセットアップされます。

2

Conference Appのダウンロード

プロジェクトファイル一式を以下のいずれかの方法でダウンロードします。

方法A: ZIPファイルをダウンロード(推奨)

  1. プロジェクトのZIPファイルをダウンロード
  2. 任意のフォルダに解凍(例: C:\Users\kawag\work\
  3. 解凍後のフォルダ名が 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
3

フォルダ構成の確認

解凍したフォルダの中身が以下のようになっているか確認します。

conference-app/ ├── backend/ │ ├── app/ │ ├── alembic/ │ ├── Dockerfile │ └── requirements.txt ├── docker-compose.yml ├── docker-start.bat 👈 起動用バッチファイル ├── docker-stop.bat 👈 停止用バッチファイル ├── README.md ├── QUICKSTART.md ├── USER_MANUAL.html 👈 取り扱い説明書 └── DOWNLOAD_GUIDE.html 👈 本ファイル

✅ 確認ポイント

  • docker-compose.yml ファイルが存在する
  • docker-start.bat ファイルが存在する(Windows)
  • backend/ フォルダが存在する
4

Docker環境の起動

いよいよアプリケーションを起動します。

Windows の場合:

  1. Docker Desktopを起動(タスクトレイのアイコンが緑色になるまで待つ)
  2. conference-app フォルダを開く
  3. docker-start.bat をダブルクリック
  4. コマンドプロンプトが開き、自動的にセットアップが始まります
[スクリーンショット: 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
5

データベース初期化

初回のみ必要な操作です。 データベースのテーブルを作成します。

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
6

動作確認

ブラウザでアプリケーションにアクセスして、正常に動作しているか確認します。

確認手順:

  1. ブラウザを開く(Chrome推奨)
  2. 以下のURLにアクセス:
[スクリーンショット: Swagger UI画面]

✅ 正常に動作している場合

  • Swagger UIの画面が表示される
  • 「Conference App API」というタイトルが見える
  • 複数のAPIエンドポイントが一覧表示される

追加確認(オプション):

ヘルスチェックエンドポイントにアクセス:

以下のJSONが表示されればOKです:

{
  "status": "ok",
  "version": "1.0.0"
}

🎉 セットアップ完了!

おめでとうございます!

Conference Appのセットアップが完了しました。

これで学会大会管理システムを使い始めることができます。

次のステップ

  1. 取り扱い説明書を確認 - USER_MANUAL.html を開いて基本操作を学ぶ
  2. ユーザー登録 - Swagger UIから最初のユーザーを登録
  3. 大会情報を登録 - テスト用の大会データを作成
  4. セッションを追加 - 口頭発表やポスターセッションを登録

⚙️ 日常的な使い方

起動方法(2回目以降)

  1. Docker Desktopを起動
  2. docker-start.bat をダブルクリック(Windows)
  3. ブラウザで http://localhost:8000/api/v1/docs にアクセス

停止方法

  1. docker-stop.bat をダブルクリック(Windows)
  2. または: docker-compose down をコマンドで実行

💡 ヒント

PCを再起動してもデータは保持されます。Docker Desktopを起動して docker-start.bat を実行すれば、前回の続きから使えます。

🔧 トラブルシューティング

問題1: Docker Desktopが起動していない

症状: ❌ エラー: Docker Desktopが起動していません

解決策:

  1. Docker Desktopアプリケーションを起動
  2. タスクトレイのDockerアイコンが緑色になるまで待つ(1〜2分)
  3. docker-start.bat を再実行

問題2: ポートが既に使用されている

症状: Error: Port 8000 is already in use

解決策:

  1. 既存のコンテナを停止: docker-compose down
  2. ポート使用状況を確認: netstat -ano | findstr :8000 (Windows)
  3. 必要に応じて該当プロセスを終了

問題3: マイグレーションエラー

症状: sqlalchemy.exc.OperationalError

解決策:

  1. PostgreSQLコンテナが起動しているか確認: docker-compose ps
  2. 少し待ってから再試行(起動に時間がかかる場合あり)
  3. それでもダメな場合: docker-compose down -v でボリューム削除後、最初から再実行

💬 サポート

問題が解決しない場合は、以下を確認してください:

  • Docker Desktopのバージョンが最新か
  • ディスク容量が十分にあるか(5GB以上)
  • ファイアウォールやウイルス対策ソフトがDockerをブロックしていないか

それでも解決しない場合は、開発者またはサポート窓口に連絡してください。

📚 関連ドキュメント

🎓 学習リソース

🚀 さっそく使ってみましょう!

セットアップが完了したら、USER_MANUAL.html を開いて基本操作を学び、実際に大会データを登録してみてください。