README.md

portfolio-backend

GitHub Organization 「nekochans」の説明用Webサイトのバックエンド

環境変数の設定

以下の環境変数を設定する必要があります。

export GCP_PROJECT_ID="作成したGCPのProjectID"
export DB_USER="nekochans"
export DB_PASSWORD="nekochans(Password2222)"
export DB_NAME="portfolio_backend"
export DB_HOST="portfolio-backend-mysql"
export TEST_DB_USER="nekochans_test"
export TEST_DB_PASSWORD="nekochans(Password2222)"
export TEST_DB_NAME="portfolio_backend_test"

これらのパスワードは本番のDBでは決して利用しないで下さい。

direnv 等を利用すると良いでしょう。

ローカル上でDockerで動作させる

以下のスクリプトを実行して下さい。

./docker-compose-up.sh

この記事 のように delve を使ってデバックを行う場合は以下のスクリプトを実行して下さい。

./docker-compose-up-debug.sh

マイグレーションの実行

各コンテナが起動した状態で以下を実行して下さい。

# データベースにマイグレーションの実行
docker-compose exec go make migrate-up

# マイグレーションをロールバックする
# Are you sure you want to apply all down migrations? [y/N] と2回聞かれるので y でEnterして下さい
docker-compose exec go make migrate-down

詳しくは migrate のドキュメントを参照して下さい。

Docker Hubに反映する

docker-push.sh を実行して下さい。

gcr（Container Registry）に反映する

docker-push-to-gcr.sh を実行して下さい。

Lintの実行

docker-compose exec go sh でアプリケーション用のコンテナに入ります。

make lint を実行して下さい。

もしくは docker-compose exec go make lint でも実行出来ます。

lintのルール等は以下を参考にして下さい。

https://golangci-lint.run/usage/linters/

ここで表示されたエラーは修正を行う必要があります。

一部のエラー内容は後で解説する make format コマンドでも修正可能です。

ソースコードのフォーマット

docker-compose exec go sh でアプリケーション用のコンテナに入ります。

make format を実行して下さい。

もしくは docker-compose exec go make format でも実行出来ます。

このコマンドで自動修正されない物は自分で修正を行う必要があります。

テストの実行

docker-compose exec go sh でアプリケーション用のコンテナに入ります。

make test を実行します。

もしくは docker-compose exec go make test でもテストを実行出来ます。

データベース（MySQL）への接続方法

お使いのPCにMySQLクライアントをインストールして以下のコマンドで接続して下さい。

mysql -u root -h 127.0.0.1 -p -P 63306

本番環境ではMySQLではなく、AWS、GCPのマネージドサービスを利用します。

OpenAPIスキーマの更新

APIはスキーマ駆動で開発を行っています。

スキーマは こちら で管理されています。

スキーマの更新があった場合以下のコマンドでインターフェースの更新を行う必要があります。

まずは以下の更新でGitのサブモジュールとして登録されている openapi.yaml を更新します。

git submodule update --recursive --remote

docker-compose exec go sh でアプリケーション用のコンテナに入ります。

以下を実行します。

oapi-codegen -generate types docs/openapi/docs/portfolio/openapi.yaml > openapi/model.gen.go
oapi-codegen -generate chi-server docs/openapi/docs/portfolio/openapi.yaml > openapi/server.gen.go

生成されたコードという事が分かるように .gen.go という拡張子にしています。

エディタによってはコードを変更しようとすると警告が出るようになります。

生成されたコードを手動で直すのは原則として禁止です。

ただしコミットする前に make lint で整形を行って下さい。