GodUploader with GraphQL
以下の環境で動作確認済です。
- Node.js v20.5.1
- Python 3.14.2
- poetry version 2.2.1
フロントエンドの開発のためにAPIサーバーを立ち上げるだけであれば、Dockerを使うのがおすすめです。
docker docker-compose コマンドが叩ける状態であれば、以下のコマンドでAPIサーバーを立ち上げることができます。
$ docker-compose up --build
以降のセクションに書いてあるコマンドは全て api ディレクトリ以下で、Docker環境外で実行してください。
依存ライブラリの管理はpoetryで行っています。
$ poetry install
$ script/init_db.sh
$ poetry run python script/main.py
http://localhost:5000/api/ping にアクセスして {"ok":true} というJSONが返ったらOKです。
tests 以下にテストがあります。
$ poetry run pytest
$ cd front
$ npm ci
$ npm run start
http://localhost:3000/ にアクセスして閲覧できればOKです。
APIサーバーを立ち上げた状態で以下のコマンドを叩くと、GraphQLスキーマ (front/schema.graphql) を更新できます。
$ cd front
$ npm run codegen
GraphQLクエリ (graphql で囲んでいる箇所) の内容を書き換えた場合、relay-compilerのコンパイルが必要になります。
$ cd front
$ npm run relay-compiler
$ npm run test
~passenger/GodUploader-graphql 以下で git pull を実行したのち、 passenger-config restart-app . を実行するとアプリケーションがデプロイされます。
hatsuneで ~passenger/GodUploader-graphql/front/deploy.sh を実行すると、GitHub Actionsでビルドされた最新の成果物がデプロイされます。
deploy.shの引数としてrun IDを渡すと、当該runの成果物を使ってデプロイを行うため、ロールバックなどに使えます。
deploy.shはGitHub APIへのアクセスに必要なトークンを OAuth2 Device Flow で取得します。スクリプトを実行すると認証用のURLとコードが表示されるので、ブラウザでURLを開いてコードを入力し、GitHubアカウントでアプリを認証してください。認証完了後にEnterキーを押すとデプロイが続行されます。
https://github.com/sqldef/sqldef からsqlite3defをインストールしておいてください。 hatsuneのpassengerユーザー以下では、sqlite3defコマンドが使える状態になっているはずです (なっていなかったらインストールしておいてください)。
apiディレクトリ以下で次のコマンドを叩くと、./schema.sql の内容に応じて ./db/god.db にあるSQLiteのDBに対してマイグレーションが実行されます。
$ sqlite3def --file=./schema.sql ./db/god.db