update readme

README.md

@@ -1,31 +1,31 @@
 # sushi-chat
+2021/04/24~04/25 [サポーターズ 技育Campハッカソンvol.2](https://talent.supporterz.jp/events/4dd93ba8-1fde-477a-8706-2d17f46c1c4d/) にて、学生4人で開発したプロダクトです。次回以降のハッカソンでの実戦投入を目指して継続開発中です。
 
-20210424~0425 サポーターズハッカソン
+🎉🎉 上記ハッカソンで[最優秀賞](https://twitter.com/geek_pjt/status/1386253688604266496)をいただきました！
 
-## 起動
+## デプロイ先
+[sushi-chat](https://sushi-chat-server.herokuapp.com)（開発中につき動作未確認）
 
-### フロント
+## 概要
+ハッカソン等のプレゼンでのリアルタイムなフィードバックをより便利にするチャットアプリです。
 
-1. Docker コンテナ立ち上げ
+他の参加者によるコメント投稿機能のほか、スタンプでのリアクション、質問の投稿など、プレゼンを盛り上げる役割に特化しています。
 
-docker-compose.yml があるパスで`$ docker-compose up`
+![スクリーンショット](/resource/pc-screenshot.jpeg)
 
-2. ブラウザでアクセス
-   `http://localhost:3000`
+## 開発期間
+ハッカソン：2021/4/17 ~ 4/25
 
-### サーバー
+継続開発1：2021/4/26 ~ 2021/5/8
 
-#### リモート
+## 利用技術
+- フロントエンド：TypeScript Nuxt.js Docker Vercel
+- バックエンド：Node.js TypeScript express heroku
+- リアルタイム通信：SocketIO
+- その他：Github Discord Notion GithubActions（自動デプロイ）
 
-/serverで
+## ハッカソン資料
+[ハッカソンプレゼン資料](https://docs.google.com/presentation/d/1A8hxD4WBBODAvX_OhhWMsc2PKykCHYYPn0KdOFvcwsg/edit?usp=sharing)
 
-`npm install`で必要なもの入れる
-
-`npm run dev`して適当なところにアクセス
-
-#### heroku
-
-main に pull-request すれば以下にデプロイされるはず
-<https://sushi-chat-server.herokuapp.com>
-
-手動のデプロイは一番上のディレクトリで`git subtree --prefix server push heroku main`
+# おすしアカデミー
+京大生4人で組んだチームです。

app/front/README.md

@@ -1,20 +1,11 @@
 # front
 
-## Build Setup
+## 起動
 
-```bash
-# install dependencies
-$ yarn install
+1. Docker コンテナ立ち上げ
 
-# serve with hot reload at localhost:3000
-$ yarn dev
+    docker-compose.yml があるパスで`$ docker-compose up`
 
-# build for production and launch server
-$ yarn build
-$ yarn start
-
-# generate static project
-$ yarn generate
-```
-
-For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).
+2. ブラウザでアクセス
+
+   `http://localhost:3000`

server/README.md

@@ -38,4 +38,15 @@
    例
    ```
    npm run test -- ./src/__test__/chat.ts
-   ```
+   ```
+
+## デプロイ
+
+main に pull-request すれば以下にデプロイされるはず
+
+<https://sushi-chat-server.herokuapp.com>
+
+手動のデプロイは一番上のディレクトリで
+```
+git subtree --prefix server push heroku main
+```