Merge pull request #110 from sharehouse-sanhaimu/fix/nose/readme

readmeの編集

README.md

@@ -2,9 +2,11 @@
 
 【技育 CAMP2024】ハッカソン Vol.1 に参加して作成したアプリ
 
+こちらからアクセス ⇒ [ChatGP（チャットグランプリ）](https://chatgp.nosse.net/)
+
 ## Description
 
-プロジェクトの概要
+chatGPT を使ったレースゲーム！
 
 ## Installation
 
@@ -13,19 +15,24 @@
 ```bash
 docker compose -f docker-compose.prod.yml build
 
+docker compose -f docker-compose.prod.yml run --rm view yarn
+
 docker compose -f docker-compose.prod.yml run --rm view yarn build
 
 docker compose -f docker-compose.prod.yml up -d
 ```
 
 ## File Structure
 
-- api/
+- `api/`
+
   - FastAPI を使用したバックエンド処理を記述
 
-- view/
-  - Next.jsを用いてフロントエンドを構築
+- `view/`
+
+  - Next.js を用いてフロントエンドを構築
+
 
-- docker-compose.yml
+- `docker-compose.yml`
   - 複数のコンテナを定義し、実行するための設定
 

api/README_BACKEND.md

@@ -4,12 +4,6 @@
 ## Description
 FastAPIを使用してChatGPTAPIを操作できるようにする.
 
-## Installation
-
-```bash
-docker compose build 
-docker compose up
-```
 
 ## Usage
 API使用方法

view/README_FRONTEND.md

@@ -0,0 +1,41 @@
+# view
+フロントエンドを記述
+
+## Description
+FastAPIを使用してChatGPTAPIを操作できるようにする.
+
+## Usage
+各ディレクトリの説明
+
+- `.yarn/`
+  - yarnのバージョン情報が入っている
+
+- `public/`
+  - 使用画像が入っている
+
+- `src/`
+  - `app/`
+      - `page.tsx`
+        - `/`のページ内容
+      - `layout.tsx`
+        - プロジェクト全体を囲むtsx
+        - `create/`
+          - 車作成画面
+          - `result/`
+            - 作成された画像を表示する画面
+        - `race/`
+          - レースが進行する画面
+        - `ending/`
+          - エンディングを表示する画面
+  - `components/`
+    - shadcn/uiがここにinstallされる
+  - `lib/`
+    - 各関数を設定
+    - serverActionsなどがある
+  - `tailwind.config.ts`
+    - tailwindの設定を記述
+    - 枠つき文字などをここで追加している
+  - `tsconfig.json`
+    - typescriptの設定が記述されている
+  - `view.Dockerfile`
+    - viewのコンテナを作るためのDockerfile

web/README_WEB.md

@@ -0,0 +1,8 @@
+# Web
+デプロイ用ファイルを配置
+
+## Description
+- 必要ファイル
+  - config.yaml
+  - cert.pem
+  - トンネルID.json