h-k-nyosu / gpt-retrieval-api

0 stars 0 forks source link

gpt-retrieval-api

本リポジトリは、FastAPI アプリケーション用の Makefile を使用して、一般的なタスクを簡単に実行できるようにしました。

セットアップ

環境のセットアップは次のコマンドを実行してください:

make setup

これにより、poetry がインストールされ、仮想環境が作成されます。

テストの実行

テストを実行するには、次のコマンドを実行してください:

make test

これにより、テストが実行され、結果が表示されます。

アプリケーションの実行

開発環境でアプリケーションを実行するには、次のコマンドを実行してください:

make run

これにより、アプリケーションがポート 8000 で実行されます。http://localhost:8000 でアクセス可能です。

アプリケーションのデプロイ

アプリケーションをデプロイするには、次のコマンドを実行してください:

make deploy

これにより、 requirements.txt がエクスポートされ、その後アプリケーションが Vercel にデプロイされます。

環境のクリーンアップ

環境をクリーンアップするには、次のコマンドを実行してください:

make clean

これにより、コードベース内の不要なファイル(pycache ディレクトリなど)が削除されます。

このドキュメントは、Makefile に基づくプロジェクトの操作を説明しています。必要に応じて README に追加・編集してお使いください。