https://github.com/takumi-pro/bookmap_backend
BOOKMAPのバックエンドリポジトリ
https://github.com/takumi-pro/bookmap_backend
echo golang oapi-codegen
Last synced: 10 days ago
JSON representation
BOOKMAPのバックエンドリポジトリ
- Host: GitHub
- URL: https://github.com/takumi-pro/bookmap_backend
- Owner: takumi-pro
- Created: 2023-09-15T14:45:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-27T03:59:37.000Z (over 2 years ago)
- Last Synced: 2024-01-06T07:23:19.182Z (about 2 years ago)
- Topics: echo, golang, oapi-codegen
- Language: Dockerfile
- Homepage:
- Size: 656 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BookMap Backend
- [コーディングルール](#coding-rules)
- [開発構成の概要](#system-configuration)
- [開発環境の構築](#environment-building)
- [使用技術について](#technology-used)
- [各種リポジトリのリンク](#repository)
コーディングルール
`CONTRIBUTING.md` に記載予定
開発構成の概要
開発環境の構築
### docker network構築
まずはdocker networkを構築する
```bash
docker create network dev_bookmap
```
### docker network削除
```bash
docker delete network dev_bookmap
```
### DB起動
```bash
make up-db
```
### DB停止
```bash
make down-db
```
### DBドキュメントの確認
SchemaSpyを使用して開発環境のDBからER図やテーブル、カラム一覧情報を出力する
にアクセスすることで出力されたドキュメントを確認できる
- http://localhost:8080
起動コマンド
```bash
make up-spy
```
停止コマンド
```bash
make down-spy
```
### Dev Containerのインストール
今回は`Dev Containers（VSCode拡張機能）`を使用してコンテナ内で開発するため、インストールする
### Golang Appコンテナ起動
VSCode左下の`><`アイコンから`コンテナで再度開く`を選択
コンテナの起動に成功したら以下にアクセス可能となる
- http://localhost:8000
### OpenAPIからコード自動生成
OpenAPI仕様書に変更が加わった際にはコードにも変更を反映するためコードを生成する
```bash
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)](https://github.com/takumi-pro/bookmap_backend)
- [フロントエンド](https://github.com/takumi-pro/bookmap_frontend)
- [インフラ（IaC）](https://github.com/takumi-pro/bookmap_infra)