https://github.com/cloudnativedaysjp/dreamkast
dreamkast is Online Conference Platform !!!!!!
https://github.com/cloudnativedaysjp/dreamkast
rails ruby
Last synced: 10 days ago
JSON representation
dreamkast is Online Conference Platform !!!!!!
- Host: GitHub
- URL: https://github.com/cloudnativedaysjp/dreamkast
- Owner: cloudnativedaysjp
- License: mit
- Created: 2020-06-15T13:51:12.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-01-28T07:00:22.000Z (28 days ago)
- Last Synced: 2026-01-28T18:28:30.098Z (27 days ago)
- Topics: rails, ruby
- Language: Ruby
- Homepage:
- Size: 25.3 MB
- Stars: 31
- Watchers: 11
- Forks: 8
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dreamkast
Ruby on Railsで構築されたオンラインカンファレンスシステム
## Dreamkastプラットフォームについて
詳細は[Notion](https://www.notion.so/cloudnativedays/Dreamkast-Team-bc787244afdc45b880c014bd61891aa8)を参照してください（メンバー限定）
## 前提条件
- OS: macOS, Linux, Windows
- **Docker**
## 開発環境のセットアップ
**devbox**を使用すると、チーム全体で統一された開発環境を簡単にセットアップできます。
### devboxの利点
- **統一された開発環境**: チーム全体で同じバージョンのツールを使用
- **簡単なセットアップ**: rbenv/nodenvの手動インストールが不要
- **再現性の保証**: devbox.lockでバージョンを固定
- **AWS認証情報の自動取得**: Secrets Managerから認証情報を自動で取得
- **セキュアなシークレット管理**: 認証情報はファイルに書き出さず、環境変数として保持
**注意**: Node.jsはdevboxが提供する22系の安定版を使用します（.node-versionでは22.16.0を指定していますが、devboxでは`nodejs@22`で22系の安定バージョンを自動取得）。マイナーバージョンの違いはありますが互換性があるため、開発に支障はありません。
### クイックスタート
```bash
# 1. devboxのインストール
curl -fsSL https://get.jetify.com/devbox | bash
# 2. リポジトリのクローン
git clone https://github.com/cloudnativedaysjp/dreamkast.git
cd dreamkast
# 3. devbox環境の初期化
devbox shell
# 4. 初回セットアップ（依存関係インストール）
devbox run setup
# 5. AWS認証とシークレット取得（sourceで実行）
source bin/devbox-auth.sh
# 6. アプリケーション起動
devbox run start
```
ブラウザで `http://localhost:8080` にアクセスしてください。
### セットアップの詳細
#### 1. devboxのインストール
```bash
curl -fsSL https://get.jetify.com/devbox | bash
```
詳細:
#### 2. devbox環境の初期化
```bash
devbox shell
```
初回実行時、必要なパッケージ(Ruby、Node.js、Docker等)が自動ダウンロードされます(5-10分程度)。
#### 3. 初回セットアップ
```bash
devbox run setup
```
このコマンドは以下を実行します:
- `yarn install --check-files`
- `bundle install`
#### 4. AWS認証とシークレット取得
```bash
source bin/devbox-auth.sh
```
**重要**: `source`コマンドで実行してください。これにより認証情報が現在のシェルセッションの環境変数として設定されます。
このコマンドは以下を自動的に実行します:
- AWS SSO設定の自動構成（SSO Start URLを含む）
- AWS SSOログイン（ブラウザで認証）
- ECRログイン
- AWS Secrets Managerから認証情報を自動取得し、環境変数にエクスポート
- Auth0設定(CLIENT_ID, CLIENT_SECRET, DOMAIN)
- Rails Master Key
- AWSクレデンシャル
**セキュリティ**: 認証情報はファイルに書き出されず、現在のシェルセッション内でのみ有効です。新しいターミナルを開いた場合は再度認証が必要です。
**注意**: 初回実行時はブラウザでAWS SSOの認証が求められます。Dreamkastチームから付与されたAWSアカウントでログインしてください。
**リモート環境での認証**: リモート環境（SSH接続先など）でブラウザが開けない場合は、環境変数`DEVBOX_REMOTE=1`を使用します:
```bash
DEVBOX_REMOTE=1 source bin/devbox-auth.sh
```
このコマンドは認証URLとコードを表示するので、手元のブラウザで開いて認証を完了してください。
#### 5. アプリケーション起動
```bash
devbox run start
```
このコマンドは以下を実行します:
- Docker Composeサービスの起動（db, redis, localstack, nginx, ui, fifo-worker）
- データベースマイグレーション（`rails db:migrate`）
- シードデータ投入（`rails db:seed`）
- Railsアプリケーションの起動
ブラウザで `http://localhost:8080` にアクセスしてください。
**注意**: PC起動後は毎回`devbox run start`を実行してください。このコマンドでDockerコンテナが起動します。
### 日常の開発フロー
#### アプリケーション起動
```bash
devbox shell
source bin/devbox-auth.sh # 認証（新しいシェルセッションごとに必要）
devbox run start
```
#### テスト実行
```bash
devbox shell
devbox run test
```
または個別テスト:
```bash
bundle exec rspec spec/models/talk_spec.rb
```
#### Lint実行
```bash
bundle exec rubocop --autocorrect-all
```
#### データベース操作
マイグレーション:
```bash
bundle exec rails db:migrate
```
シードデータ投入:
```bash
bundle exec rails db:seed
```
#### Docker Composeサービスの管理
サービス一覧:
```bash
docker compose ps
```
ログ確認:
```bash
docker compose logs -f db
```
サービス再起動:
```bash
docker compose restart db
```
### トラブルシューティング
#### devbox shellが遅い
初回実行時はパッケージダウンロードで時間がかかります。2回目以降はキャッシュが効くため高速です。
#### MySQL接続エラー
```bash
# DBサービスの状態確認
docker compose ps db
# DBログ確認
docker compose logs db
# DB再起動
docker compose restart db
```
#### yarn installエラー
```bash
# node_modules削除
rm -rf node_modules
# 再インストール
yarn install --check-files
```
#### bundle installエラー
```bash
# vendor/bundle削除
rm -rf vendor/bundle
# 再インストール
bundle install
```
#### ECRログインエラー
```bash
# AWS SSOセッションの更新
aws sso login --profile dreamkast
# 認証スクリプト再実行
source bin/devbox-auth.sh
```
#### Secrets Manager取得エラー
```bash
# AWS認証状態確認
aws sts get-caller-identity --profile dreamkast
# Secrets Managerへのアクセス権限確認
aws secretsmanager describe-secret \
--secret-id dreamkast/reviewapp-env \
--region us-west-2 \
--profile dreamkast
```
アクセス権限がない場合は、Dreamkastチームに権限付与を依頼してください。
#### Rails起動時のRAILS_MASTER_KEYエラー
環境変数`RAILS_MASTER_KEY`が設定されているか確認してください。
```bash
# 設定確認
echo $RAILS_MASTER_KEY
# 未設定の場合は認証スクリプトを再実行
source bin/devbox-auth.sh
```
**注意**: 認証情報は現在のシェルセッションでのみ有効です。新しいターミナルを開いた場合は`source bin/devbox-auth.sh`を再実行してください。
## その他のセットアップ方法
devboxを使わない場合の代替セットアップ方法:
- [Docker Composeを使ったセットアップ](docs/SETUP_DOCKER_COMPOSE.md) - 最速でセットアップしたい場合
- [ローカル環境を使ったセットアップ](docs/SETUP_LOCAL.md) - rbenv/nodenvを使った従来方式
## 高度な機能
- [Ruby型定義（RBS）とVideoRegistration API](docs/ADVANCED.md)
## rubocopの自動実行
```bash
git config pre-commit.ruby "bundle exec ruby"
git config pre-commit.checks "[rubocop]"
```
## 参考リンク
- [devbox公式ドキュメント](https://www.jetify.com/devbox/docs/)
- [Dreamkast AGENT.md](AGENT.md)