diff --git a/README.md b/README.md index ab51738..abb821e 100644 --- a/README.md +++ b/README.md @@ -12,17 +12,34 @@ ## 技術スタック -- **フロントエンド**: Next.js, React -- **スタイリング**: CSS Modules または styled-components -- **バックエンド**: API routes (Next.jsのサーバレスAPI機能を使用) +- **フロントエンド**: Next.js 15.3.3, React 19.1.0 +- **スタイリング**: CSS Modules +- **開発環境**: Docker対応 ## プロジェクト構成 -詳細なフォルダとファイル構成は、プロジェクトの `src` ディレクトリを参照してください。 +``` +interview-timer-app/ +├── components/ # Reactコンポーネント +│ ├── Timer.js # タイマー表示コンポーネント +│ ├── SettingsForm.js # 設定フォームコンポーネント +│ └── Alert.js # アラート表示コンポーネント +├── pages/ # Next.jsページファイル +│ └── _app.js # アプリケーションラッパー +├── styles/ # CSSスタイルファイル +│ ├── globals.css # グローバルスタイル +│ ├── Home.module.css # ホームページ用CSS Modules +│ └── Timer.module.css # タイマー用CSS Modules +├── public/ # 静的ファイル +├── nextjs/ # Docker関連ファイル +│ └── Dockerfile # Next.jsアプリ用Dockerファイル +├── docker-compose.yml # Docker Compose設定 +└── package.json # プロジェクト依存関係 +``` ## Docker 環境のセットアップ -本プロジェクトは Docker を使用して環境を容易に構築できるように設計されています。`docker-compose.yml` ファイルには、Next.js アプリケーションと PostgreSQL データベースのサービスが定義されています。 +本プロジェクトは Docker を使用して環境を容易に構築できるように設計されています。`docker-compose.yml` ファイルには、Next.js アプリケーションのサービスが定義されています。 ### 使用方法 @@ -35,12 +52,44 @@ 3. ブラウザで `http://localhost:3000` にアクセスしてアプリケーションを使用します。 -データベースが不要な場合は、`docker-compose.yml` から `db` 関連の設定を削除してください。 +データベースが必要な場合は、`docker-compose.yml` にデータベースサービス設定を追加してください。 ## インストールと実行 +### 開発環境での実行 + 開発環境でのセットアップには、以下の手順を実行してください: ```bash +# 依存関係のインストール npm install + +# 開発サーバーの起動 npm run dev +``` + +開発サーバーが起動したら、ブラウザで `http://localhost:3000` にアクセスしてアプリケーションを使用できます。 + +### 本番環境用ビルド + +```bash +# 本番用ビルド +npm run build + +# 本番サーバーの起動 +npm start +``` + +## 現在実装されているコンポーネント + +- **Timer.js**: 基本的なカウントダウンタイマー機能 +- **SettingsForm.js**: タイマーの全体時間とセクション時間を設定するフォーム +- **Alert.js**: 通知メッセージを表示するアラートコンポーネント + +## 開発状況 + +このプロジェクトは現在開発中です。基本的なタイマー機能とコンポーネント構造が実装されており、今後さらなる機能拡張が予定されています。 + +## ライセンス + +このプロジェクトは Eclipse Public License v2.0 の下でライセンスされています。詳細は [LICENSE](LICENSE) ファイルを参照してください。