Skip to content

Commit

Permalink
README修正
Browse files Browse the repository at this point in the history
  • Loading branch information
cateiru committed Nov 2, 2023
1 parent 1d9f209 commit 4a54f25
Showing 1 changed file with 20 additions and 13 deletions.
33 changes: 20 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@ IdP

## Quick Start

- 必要なもの
- docker
- docker compose
このリポジトリでは、`docker`があれば1コマンドで開発環境を構築できます。

```bash
docker compose up
Expand All @@ -15,6 +13,15 @@ docker compose up
# (APIは http://localhost:8080 )
```

`docker compose`では、以下の4つのコンテナが立ち上がります。

|name|種類|ポート|
|:--|:--|:--:|
|`backend_app`|Goのバックエンドサーバー|`8080`|
|`frontend_app`|Next.jsサーバー|`3000`|
|`db`|MySQLサーバー|`3306`|
|`gcs`|オブジェクトストレージサーバー|`4443`|

### 管理画面に入る方法

> [!WARNING]
Expand All @@ -38,28 +45,28 @@ docker compose up
go mod download
./script/test

# ----

# Next.js lint
pnpm i
pnpm lint

# ----

# Storybook
pnpm storybook
# http://localhost:6006
```

## データベースのマイグレーション

```bash
docker compose up
このリポジトリでは、`mysqldef`を使用して簡単にマイグレーションを実行しています。

# マイグレーション用の`up`, `down`ファイルを作成します。
# `YYYYMMDDhhmmss_[name].[up|down].sql` のファイルが `db/migrations/` に追加されます。
./script/setup_migrate.sh [name]

# go-migrateを使用してマイグレーションを実行します
# ローカル環境で使用するDBとテスト環境で使用するDBの2つでマイグレーションが実行されます。
./script/migrate.sh up
```
1. `db/schema.sql`を編集します。
2. `docker compose up -d`でDBを起動します。
3. `./scripts/setup_migrate.sh [マイグレーション名]`を実行します。
4. `db/migrations/``up``down`のDDLが作成されるので内容が問題ないか確認します。
5. `./scripts/migrate.sh`を実行してデータベースにマイグレーションを実行します。

## Environments

Expand Down

0 comments on commit 4a54f25

Please sign in to comment.