update: README.md

README.md

@@ -1,16 +1,26 @@
-# TAGether - Share self-made exam for classmates
+<div align="center">
+
+# TAGether - Share your self-made exam with classmates
+
+![tagether-logo](/public/static/logo.png)
+
+</div>
 
 ## What's this
 
-誰かが作った問題をクラスの人と共有できるようなサービスです。
+テスト対策問題のような問題を作成し、クラスの人と共有できるようなサービスです。
 
 ## How to use
 
+1. [Google Cloud Console](https://console.cloud.google.com/apis/credentials/oauthclient) でOAuthクライアントを作成
+1. `cp sample-env.ts env.ts`等を
+1. env.tsを編集し、OAuthのclient idなどを適切に設定する
 1. `./start.sh` (本番環境は`./start.sh product`)
 
 ## docker-compose について
 
 最新情報は compose.yaml をチェックしてね
+
 | 名前 | ポート |
 | ------------------------ | ------ |
 | フロントエンド (Next.js) | 3009 |
@@ -19,33 +29,37 @@
 
 ## ディレクトリ構造
 
-### Docker
+### /public
+
+favicon など
+
+### /src
+
+React (Next.js) によるフロントエンド
+
+- app/
+  Next.js App router
+- assets/
+  アイコンのsvg（基本的に[Google Fonts](https://fonts.google.com/icons)から取ってきたもの）
+- db/
+  drizzleのschemaとMySQLへ接続する関数
+
+- components/
+  - common/ → 共通して使うコンポーネント
+  - features/ → 機能ごとに分ける
+- tests/
+  Vitestによるテスト
+- types/
+  型定義
+- utils/
+  JSXを返却しない関数群
+
+### /docker
 
-docker-compose 用
+docker compose 用
 
 - mysql/  
   DB 初期化の `db_init.sql`
-- nginx/  
-  nginx の設定ファイル (`api.conf`)
-
-### front
-
-React (next.js) によるフロントエンド
-
-TODO
-
-- public/  
-  favicon 用
-- src/
-  - components/
-    - common/ → 共通して使うコンポーネント
-    - features/ → 機能ごとに分ける
-    - pages/ → src/pages の実態みたいな
-    - utils/ → React に関係しないスクリプト
-  - pages
-    Next.js のルーティング用
-  - types  
-    型定義ファイル
 
 ## LICENSE