# Hack U

## サービス名

両思いチェッカー（仮）

### リンク
* [概要（未記入）](https://hackmd.io/@Do4KaluGSdqG9u8oPkw7pg/rkJysgzyc/edit)
* [補足](https://hackmd.io/@Do4KaluGSdqG9u8oPkw7pg/r1TwNgzk9/edit)
* [メッセージテキスト](https://hackmd.io/@Do4KaluGSdqG9u8oPkw7pg/rJUe9lfk5/edit)
* [何でも相談会フィードバック](https://hackmd.io/@Do4KaluGSdqG9u8oPkw7pg/SkknpSzec)

## 機能

### 機能目次

- 初回登録ページ
- プロフィールページ
- 相手のSNS指定
- 両想いの場合の通知
- 想定している対象デバイス

### 初回登録ページ

- SNSを入力してロクイン

### プロフィールページ

- プロフィールの参照
- 自分が好きな相手の編集（好きな相手の好き度などを編集）
- ログアウト
- アカウント削除

## MVP

- スマホサイズのウェブサイト

- 初回登録ページ
- SNS(Twitter)登録によるアカウント登録
- 友達リストページ？
- 好きな人に設定する
- 公式からのDMで通知

### サブ

- Twitterの乗っ取り
- TLに投稿
- プロフィール
- 好き度の変更

### サブサブ

- DMの内容を乱択でTLに流す
- 成立したら追放

## 事前準備
- フロントエンドの技術選定
- TypeScript, React
- バックエンドの技術選定
- Go, gin, sqlx
- https://github.com/gin-gonic/gin
- https://github.com/jmoiron/sqlx
- フロントとどう繋ぐか、API設計
- Swagger
- DBのスキーマの設計
- mysql
- デプロイ
- zliのサーバ

### API設計

#### MVP
- 友達リスト(マイページ)
- 認証必須
- GET /friends
- レスポンスは配列で相互フォローの人の情報が返ってくる
- 好き度を設定する
- 認証必須
- POST /friends/:id
- リクエストのボディで好き度を渡す
- レスポンスでマッチ成功したかどうかを返す
- このタイミングでサーバーはお互いのTwitterのtokenを使ってDMに「好きです」を送る
- TLに投稿
- 現在両思いになっている人がいるかどうかを確認する
- 認証必須
- GET /me/lover
- いれば両思いになっている人の情報を、いなければ404 not foundを返す
- 好き度を設定した人一覧の取得
- 認証必須
- GET /me/lovers
- 好き度を設定したユーザーの一覧を返す
- 破局を報告する
- 認証必須
- DELETE /me/lover
- 破局理由、Twitterに公開していいかを送り、カップルのもう片割れが既に破局手続きをしていた場合はTwitterに公開するかの処理をする
- 認証
- TwitterのAPI仕様によるのであとで決める

#### サブ

- 好きな相手の評価の削除※POSTとDELETEで編集可能
- DELETE /friends/:id
- マッチした相手とのトークルーム
- 過去の会話の取得
- GET /me/lover/talks
- メッセージを送る
- POST /me/lover/talks
- リアルタイムで会話を取得する
- Websocketでコネクションを貼る

#### サブサブ

- 公式のTwitterアカウントがDM、カップルを公開
- cronあたりを使って乱択する

### バックエンド

#### 技術選定

- バックエンドの技術選定
- Go, gin, sqlx
- https://github.com/gin-gonic/gin
- https://github.com/jmoiron/sqlx
- フロントとどう繋ぐか、API設計
- Swagger
- DBのスキーマの設計
- mysql
- デプロイ
- zliのサーバ

#### Goのパッケージ構成(WIP)

- main.go
- model
- user.go
- chat.go
- love.go
- controller // 主にginのハンドラを置く場所
- friends.go
- me.go
- chat.go
- json.go
- usecase // ビジネスロジックを置く場所
- get_twitter_login_url.go
- handle_twitter_callback.go
- friends_search.go
- get_followees.go
- get_followers.go
- get_love_point.go
- get_love_points.go
- set_love_point.go
- get_current_lover.go
- delete_current_lover.go
- get_chat_history.go
- repository // MySQLとデータをやりとりする場所
- user.go
- chat.go
- service
- twitter.go // Twitter APIとやりとりする
- jwt.go // JWT周り
### フロント

#### 使いそうなライブラリ

- react(create-react-app)
- react-router-dom
- usehooks-ts
- socket.io-client
-

#### 作成しそうなhooks

- useId
- 自身の id を取得する
- useFriends
- 自身の id とかを渡すと /friends を叩いてくれる
- useLike
- 好き度設定したりする
- useChat
- socket.io-client のラッパー的なやつ
- messages: {id: string, text: string}
- sendMessage(text: string)
- hakyoku()
- useTwitter(的なやつ)
- useTwitterAuth
- useTwitterShare
- useTwitterLogin
- などが必要になるやも

#### 構成

- page
- 初回ページ
- Twitterログイン後のページ
- 好きな人リストのページ
- 好きな人がいる状態・いない状態
- 好きな人追加のページ
- 両思いになった相手を知らせるのページ
- （Twitter~のページと構成はほぼ同じ）
- もう戻ってくるなページ
- チャットルーム
- 破局理由のページ
- 格言ページ（開始可能・不可能のにパターンに対応）

- component
- テキストボタン
- 背景有・無
- 押せる・押せない
- ラジオボタン
- チェックボックス
- アイコン付きボタン
- ボタングループ
- ロゴ
- ユーザのカード（編集ボタン有・無）
- ユーザのリスト
- ユーザアイコン（S・M・L）
- ポップアップ
- 中身は自由に入れられるといい
- アイコン
- ＋
- ゴミ箱
- 編集
- ハート
- 歯車
- 戻る（左矢印）
- ハート（割れ）
- 送信（紙飛行機）
- 検索
- メッセージ
- 自分から相手
- 相手から自分
- 入力欄
- 内部テキスト付き
- 検索アイコン付き
- 背景付属させるやつ

- css
- 汎用
- 背景
- 文字色
- スペーシング
- 陰
-