このリポジトリは?

HigaCoffee のデータベースプロジェクトのバックエンドです。 HigaCoffee ではコーヒーを題材にフロント開発・バックエンド開発・機械学習をやってみたい人を募集しています。

API 仕様

URL	Method	説明	備考
/	GET	hello world
/	POST	オウム返し
/coffees	GET	条件にあうコーヒー取得
/coffees	POST	コーヒー登録
/reviews	GET	レビュー取得
/reviews	POST	レビュー登録
/auth/login	POST	ログイン
/auth/create_user	POST	ユーザー登録
/beans	GET	豆の種類取得

実行方法

1. 仮想環境作成 $ python -m venv venv

2. 仮想環境有効化 $ source venv/bin/activate

3. パッケージインストール(requirements.txt から)
   $ pip install -r requirements.txt

4. インストール済みのパッケージを requirements.txt に記載 pip freeze > requirements.txt

5. DB 作成

   1. データベースを作成し、URI を環境変数DATABASE_URIに保存
      ※ デフォルトでは higa という PostgreSQL の DB が使われる。この場合 PostgreSQL に higa という DB を作成する必要がある。

6. マイグレーション

   1. (マイグレーションディレクトリ作成)
      マイグレーション(DB 構造を models と自動で一致させる)するために必要。
      ただしこのリポジトリではすでに存在しているため不要

      $ flask db init
      

   2. マイグレーションファイル作成
      「DB 構造をこう変えてくださいね」っていうファイルができる(=マイグレーションファイル)

      $ flask db migrate
      

   3. マイグレーション実行
      マイグレーションファイルに基づいて DB 構造が変更される。

      $ flask db upgrade
      

7. .env.sampleを参考に.env ファイルを作成。

8. ローカルサーバ立ち上げ
   $ python run.py

テスト

1. テスト DB 作成。

2. URI を環境変数TEST_DATABASE_URIに保存
   ※ デフォルトでは higa_test という PostgreSQL の DB が使われる。この場合 PostgreSQL に higa_test という DB を作成する必要がある。

3. テスト実行

   $ pytest
   

   test_*.pyがすべて実行される。
   ※base.pyに記載の処理が test メソッドのたびに行われる。