メインコンテンツまでスキップ

開発ガイド

ローカル開発環境のセットアップと開発ワークフローを説明します。

セクション一覧​

はじめる​

開発の基本​

API仕様​

  • API仕様: 外部公開APIの定義とProtocol Buffers

バックエンド・フロントエンド​

リファレンス​

クイックスタート​

# 依存関係インストール
pnpm install
make go/tidy

# データベース起動
make compose/db.up
make db/mig-up

# アプリケーション起動
make compose/up

前提条件​

  • Go 1.25+
  • Node.js 22+
  • pnpm 10.18.1
  • Docker & Docker Compose
  • buf (Protocol Buffers)

主要コマンド​

Docker Compose​

make compose/up      # 起動
make compose/down    # 停止
make compose/logs    # ログ確認

データベース​

make db/mig-up       # マイグレーション実行
make db/mig-down     # ロールバック
make db/reset        # リセット

Protocol Buffers​

make proto/gen       # コード生成
make proto/lint      # リントチェック

Go​

make go/fmt          # フォーマット
make go/test         # テスト実行
make go/tidy         # 依存関係整理

関連ドキュメント​