go-api-server-playground

README

go-api-server-playground

kyu08がGoの素振りをするためのリポジトリです。

実装内容や使用技術など

題材	Twitter風のAPIサーバー
言語	Go 1.23
通信方式	gRPC
DB	MySQL 8.4
CI	GitHub Actions
依存関係更新	dependabot
ローカルでのコンテナ実行ツール	docker compose
E2Eテストツール	runn
Goコードのlint	golangci-lint
SQLからのコード生成	sqlc
SQLのlint, format	sqlfluff

各種手順

エンドポイント更新時の手順

1. api/twitter.protoを更新
2. make gen-proto

DDL更新時の手順

1. ./sql/schema/schema.sqlを更新
2. make gen-sqlc

DML更新時の手順

1. ./sql/query/query.sqlを更新
2. make gen-sqlc

ローカルでの起動手順

1. make container-upでコンテナを起動する

ローカルでの開発手順

1. make dev-toolsで必要なツールをインストール
2. 必要に応じてmake test-e2e, make lintなどを実行