Fix/func name

README.md

@@ -1,8 +1,106 @@
-# treasure-app
+# Arxiv Cloud ☁📄
 
-> Remember, Makefile is always your friend
+## 概要
+
+- 日頃の論文サーベイのをより良く、更なる研究を。
+- バックエンド Go, フロントエンド React, サーバ MySQL, ユーザ認証 Firebase
+- URL: none
+- github: here
+
+<div align="center">
+<img src="normal.png" width="400">
+<img src="tags.png" width="400">
+</div>
+
+## コア体験
+
+- Arxiv にある論文を検索、自動で和訳した Abstract や抽出されたキーフレーズによるタグを表示し、より高速な論文サーベイ・タグの可視化ができる<br>
+
+- 動機
+  - 論文サーベイは時間がかかるが、より高速に様々な論文を読みたい。
+  - 日本語で読むほうが早い / 文章のキーワードがあるとより早く判別しやすい
+  - 単純なテキスト表示だけでなく、論文の動向の可視化を行いたい
+
+## コア機能
+
+論文検索・和訳表示・タグの可視化(word cloud)
+
+-
+
+1. 論文検索
+
+- [Arxiv API](https://arxiv.org/help/api)
+- Get でクエリに検索ワード、検索個数を載せてリクエストを送ると html 形式で返してくる
+
+2. 和訳表示
+
+- [Google Cloud Translation API](https://cloud.google.com/translate/pricing?hl=ja)
+- いつもの。V2 だと有料なので、V3beta1 を経由すべき。
+
+3. タグの可視化
+
+- [react-tag-cloud](https://www.npmjs.com/package/react-tag-cloud])のパッケージ
+- word cloud を react 経由で使える。preact はダメなので注意を。
+
+## コア機能の設計
+
+### ユーザに関して
+
+| Name         | About                          | Type   |
+| :----------- | :----------------------------- | :----- |
+| id           | ユーザー ID を保持             | int    |
+| firebase_uid | firebase のユーザー ID を保持  | string |
+| email        | ユーザーのメールアドレスを保持 | string |
+| display_name | ユーザー表示名を保持           | string |
+| photo_url    | ユーザー表示画像 URL を保持    | string |
+| ctime        | user を作成した時間            | date   |
+| utime        | user を更新した時間            | date   |
+
+user
+
+### 論文に関して
+
+#### ツイート内容
+
+| Name  | About                      | Type   |
+| :---- | :------------------------- | :----- |
+| id    | 論文の id を保持           | int    |
+| title | 論文の タイトル(EN) を保持 | string |
+| body  | 論文の Abstract(JP) を保持 | text   |
+| ctime | article を作成した時間     | date   |
+| utime | article を更新した時間     | date   |
+
+article - has many tag
+
+#### タグ内容
+
+| Name       | About                        | Type   |
+| :--------- | :--------------------------- | :----- |
+| id         | タグの id を保持             | int    |
+| article_id | 紐づいている論文の id を保持 | int    |
+| tag        | タグの内容(jp) を保持        | string |
+| ctime      | tag を作成した時間           | date   |
+| utime      | tag を更新した時間           | date   |
+
+tag - belong to article
+
+## URI 設計
+
+| Methods | URI         | About                                               |
+| :------ | :---------- | :-------------------------------------------------- |
+| GET     | /paper      | ArxivAPI に対し query に keyword を入れて検索       |
+| GET     | /articles   | 全ての論文を出す                                    |
+| GET     | /tags       | 全ての論文に紐づいたタグをだす(word cloud に投げる) |
+| POST    | /delete/:id | 特定の論文を削除、見た目状の変化なし                |
+
+## View 設計
+
+| ページ              | 内容                 |
+| :------------------ | :------------------- |
+| index.html / App.js | React 経由で全て表示 |
+
+## local 環境
 
-### local環境
 ```
 ❯ docker --version
 Docker version 18.09.2, build 6247962
@@ -18,4 +116,5 @@ v10.15.3
 ```
 
 ### Links
- - https://12factor.net
+
+- https://12factor.net

backend/README.md

@@ -1,12 +1,20 @@
+# Slide
+
+https://go-talks.appspot.com/github.com/voyagegroup/talks/2019/treasure-go-day2/intro.slide#1
+
 # Getting Started
 
 ## 1. Database 立ち上げ
 
 `../database` に構成などが定義されているので、読んでみてください。
 
+以下のターゲットを叩くと、databaseの準備をします。
+
 ```console
 ❯ make -f integration.mk database-init
-make -C ../database init
+```
+
+```console
 which goose || GO111MODULE=off go get -u github.com/pressly/goose/cmd/goose
 /Users/j-chikamori/go/bin/goose
 docker-compose up -d
@@ -72,9 +80,14 @@ PORT=1991
 使っているAPI: [Exchange custom token for an ID and refresh token](https://firebase.google.com/docs/reference/rest/auth/#section-refresh-token)  
 それぞれのキーについては、上記リンクを見れば大体分かる。
 
+トークンの作成
+
 ```console
 ❯ make -f integration.mk create-token UID=demo
 go run ./cmd/customtoken/main.go demo .idToken
+```
+
+```console
 {
   "kind": "identitytoolkit#VerifyCustomTokenResponse",
   "idToken": "idtoken",
@@ -88,17 +101,27 @@ go run ./cmd/customtoken/main.go demo .idToken
 
 ## 5. Hello World
 
+*サーバー立ち上げ*
+
 ```console
 ❯ make run
 go run cmd/api/main.go
+```
+
+```console
 2019/08/08 11:32:47 server.go:51: Listening on port 1991
 ```
 
 サーバーを立ち上げた状態で、別シェルから以下を叩く。
 
+*認証ありエンドポイントへのリクエスト*
+
 ```console
 ❯ make -f integration.mk req-private
 curl -v -H "Authorization: Bearer Hoge" localhost:1991/private
+```
+
+```console
 *   Trying ::1...
 * TCP_NODELAY set
 * Connected to localhost (::1) port 1991 (#0)
@@ -116,10 +139,16 @@ curl -v -H "Authorization: Bearer Hoge" localhost:1991/private
 <
 * Connection #0 to host localhost left intact
 {"message":"Hello  from private endpoint! Your firebase uuid is demo"}
+```
 
+*認証なしエンドポイントへのリクエスト*
 
+```console
 ❯ make -f integration.mk req-public
 curl -v localhost:1991/public
+```
+
+```console
 *   Trying ::1...
 * TCP_NODELAY set
 * Connected to localhost (::1) port 1991 (#0)
@@ -149,16 +178,29 @@ curl -v localhost:1991/public
 
 コードを書き換える度に `go run` し直すのは面倒くさいので、書き換えるとrebuildしてくれるコマンドを用意しているので活用してください。
 
+realizeをgo getする
+
 ```console
 ❯ make dev-deps                     
   GO111MODULE=off go get -u -v \
                   github.com/oxequa/realize
+```
+
+```
   github.com/oxequa/realize (download)
   github.com/oxequa/interact (download)
   github.com/fatih/color (download)
   github.com/fsnotify/fsnotify (download)
+```
+
+realizeを使って実行する
+
+```console
 ❯ make refresh-run
 realize start
+```
+
+``` console
 [11:36:48][BACKEND] : Watching 21 file/s 14 folder/s
 [11:36:48][BACKEND] : Install started
 [11:36:51][BACKEND] : Install completed in 3.653 s