TakumaKurosawa / basic-package-go-template

標準ライブラリ+gorilla/muxを使ったAPIサーバテンプレート

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

basic-package-go-template(APIサーバ)

標準ライブラリ+gorilla/muxを使ったAPIサーバテンプレート

ブランチルール

  • デフォルトブランチ=develop
  • 新規ブランチ作成時
    • feat/[issue番号]/[タスクの内容(迷えばissueのタイトル)]
  • develop=開発環境
  • master=プロダクション環境
  • masterdevelopへのforced pushは🆖
  • Squash and mergeのみ許可。コミット履歴をきれいにまとめる。

初回起動(セットアップ)

  1. .env_exampleをコピーして、.envファイルを作成
  2. 自分の環境(MySQL)に合わせて環境変数を書き換える
  3. メンバーからfirebaseCredential.json(Firebaseの認証情報)をもらい、プロジェクトのルートディレクトリに配置する
  4. db/mysql/ddl/ddl.sqlをローカルのMySQLにてRUNする
  5. make runコマンドでサーバが立ち上がる

Makeコマンド

help                           使い方
wiregen                        wire_gen.goの生成
test                           testの実行
lint                           lintの実行
fmt                            fmtの実行
fmt-lint                       fmtとlintの実行
run                            APIをビルドせずに立ち上げるコマンド
build                          APIをビルドして立ち上げるコマンド

About

標準ライブラリ+gorilla/muxを使ったAPIサーバテンプレート


Languages

Language:Go 95.3%Language:Makefile 4.7%