LaradockをベースにしたLaravelのボイラープレートを作りました!


自己紹介

皆さん、はじめまして!
記事の内容に入る前に、簡単な挨拶を。

人生初の記事投稿です。
これまでは気が向いた時に勉強して自己満足してたのですが
これからは、学習した内容とか日々の気付きなどを、せっかくなのでアウトプットしていけたらと思います!(メモとしても)
至らない点もあるかと思いますが、よろしくお願いします!

※2020/10/19 追記
記事を投稿して早々、GitHubにTemplateRepositoryというオプションがあることに気づいたので、そちらのやり方で使用方法の項目を修正しました。

概要

Laradockをベースにした、Laravelのボイラープレートを作ったので、
それの紹介と簡単なイントロダクションをします。

ボイラープレートだけ欲しい方は、下記のリンクからどうぞ!
https://github.com/ryuyaF/LaravelBoilerplateOfLaradock

なぜ作ったのか

前から気になっていたLaradockを触ってみた際に、結構使い勝手が良かったのと
勉強も兼ねて、自前のLaravelのボイラープレートを作ってみたいな〜と思っていたからです。

自前のボイラープレートっておいしいの?

Laradockのボイラープレート自体は、探せばいくらでも有用なものがあるので、ぶっちゃけ作る意味はそこまでないです。
ですが、今回自前で用意したメリットとしては、下記のようなものがあるかなと思います。

Laradockのインストール方法をいつまでも覚えていられない

Laradockに限った話ではないですが、
私の場合はプロジェクトを作る際、大抵は作り方がうろ覚えです。なんとなくの流れを覚えている程度です。
その度に、公式ページを見て、細かい設定方法やルールを確認し、作ってもいいのですが、、、面倒ですよね。
作りたい時にパッと用意する。
そういう点に魅力を感じる方にはおすすめです。

好みの構成に出来る

自分好みって良いですよね。作業しやすいです。

簡単なイントロダクション

ディレクトリ構成と解説

YourProjectName/
  └App/
  └data/
  └laradock/ ※サブモジュール
  └env-example ※laradockのenv-example
  • App
    • Laravelのインストールディレクトリ
  • data
    • mysqlのdataディレクトリ
      • DATA_PATH_HOST=../data
      • 初期設定では、laradockディレクトリの直上(=プロジェクトディレクトリの直下)に設定されている
      • ※Volumeディレクトリを変えたい場合は、laradock/.envDATA_PATH_HOSTを変更する
  • laradock
  • env-exampleファイル
    • サブモジュールは特定コミットをCloneする
    • laradockのenvファイル共通化のため、カスタマイズされたものを配置している

使用方法

  1. リポジトリにアクセス
  2. Use This Templateをクリック
  3. 必要な情報を入力してCreate repository from templateをクリック
  4. ちょっと待つと、リポジトリが作成される
  5. あとは、CloneするところからREADMEの流れに沿って作業すれば完了

こだわりポイント

Laradockリポジトリをサブモジュール化

Laradockを単にCloneしたものをリポジトリに含めるのではなく、サブモジュールとしてリポジトリに定義しました。
それによって、Laradockリポジトリの更新が反映しやすくなったかと思います。

Laradockのenvファイルをカスタマイズして、自前のリポジトリにて管理

Laradockをサブモジュール化したことによって、Cloneする際に、Laradockのenv-exampleファイルが直接管理できなくなりました。
なので、env-exampleを外出しして、カスタマイズできるような構成にしました。

XDebugの設定

今回はとりあえず、Laradockを使用したLaravelのボイラープレートの作成が目的でしたので、気が向いたら今後追記します。