BookMap Backend

• コーディングルール
• 開発構成の概要
• 開発環境の構築
• 使用技術について
• 各種リポジトリのリンク

コーディングルール

`CONTRIBUTING.md` に記載予定

開発構成の概要

開発環境の構築

docker network構築

まずはdocker networkを構築する

docker create network dev_bookmap

docker network削除

docker delete network dev_bookmap

DB起動

make up-db

DB停止

make down-db

DBドキュメントの確認

SchemaSpyを使用して開発環境のDBからER図やテーブル、カラム一覧情報を出力する にアクセスすることで出力されたドキュメントを確認できる

• http://localhost:8080

起動コマンド

make up-spy

停止コマンド

make down-spy

Dev Containerのインストール

今回はDev Containers（VSCode拡張機能）を使用してコンテナ内で開発するため、インストールする

Golang Appコンテナ起動

VSCode左下の><アイコンからコンテナで再度開くを選択

コンテナの起動に成功したら以下にアクセス可能となる

• http://localhost:8000

OpenAPIからコード自動生成

OpenAPI仕様書に変更が加わった際にはコードにも変更を反映するためコードを生成する

oapi-codegen -package bookmap -generate server reference/bookmap.yaml > src/gen/bookmap.gen.go

使用技術について（仮）

言語・フレームワーク

• Golang 1.19
• Echo 4.11.1

OpenAPI Code Generator

• oapi-codegen

各種リポジトリのリンク

• バックエンド(api)
• フロントエンド
• インフラ（IaC）