relaym-server

README

Relaym Server

Relaym のサーバーサイド API を管理するリポジトリです。

API 仕様はこちら

開発に参加するには？

1. CAMPHOR- Code of Conductに同意してください。
2. CAMPHOR- Labに参加しましょう!

開発を始める前に

STEP1 サービス内容を理解する

詳しくはこちらのリンクを参照してください。 Relaym PRD (プロダクト要求仕様書)

単語の定義もdocs/definition.mdからご覧ください。

STEP2 アーキテクチャを理解する

API リクエストは HTTP で受け付けています。曲の操作にSpotify Web APIを使用しています。

詳しくは docs/architecture.mdをご覧ください。

STEP3 データベースの設計を理解する

Relaym では MySQL をデータベースとして採用しています。

詳しくは docs/database.mdをご覧ください。

STEP4 アプリケーションアーキテクチャを理解する

DDD や Clean Architecture ライクなアーキテクチャを採用しています。

詳しくは docs/application_architecture.mdをご覧ください。

開発

ローカル開発環境のセットアップ

詳しくは docs/development.mdをご覧ください。

一般的な開発ルール

• GitHub Flow を用いたブランチ管理を行います。
• 設計は GitHub Issue を使って行います。
  • 新規機能の場合は必ず Issue を立てます。
• PR, Issue, Commit, Comment は全て日本語を可とします。

レビュー

PR のマージにはレビュワーの Approve を必要とします。

レビューで確認すべき一般的な事項はGoogle エンジニアリング・プラクティス ドキュメントに従います。

Go に関する作法は以下のドキュメントに従います。

• Go Codereview Comments
• Effective Go