【Laravel10】Laravel sailのプロジェクトをクローンした後に開発できるようにする方法

はじめに

Laravelの環境構築にLaravel sailを用いていた場合は、ComposerなどでLaravelをインストールして環境構築をした場合と比べて、GitHubからクローン後にすることが若干異なります。

今回はLaravel sailで環境構築をしているプロジェクトをクローンした場合に、開発できる環境を構築する方法を解説していきます。

GitHubリポジトリからクローン

まずはGitHubのリポジトリから下記コマンドでクローンしましょう。

$ git clone リポジトリURL

.envの作成

次は、プロジェクトの設定などが記述されている.envファイルを作成していきます。
というのも、.envファイルは通常Git管理外としているため、開発環境用に作成する必要があります。

この際に、通常は.env.exampleファイルからコピーして作成しますが、プロジェクトによっては.env.localなど別の名前を付けていることもあります。
クローンしたディレクトリに.envという名前が付いたファイルが複数あり、どれを開発環境用に使用するのかわからない場合はサクッとリーダーにどの.envファイルを使用するのか確認してしまいましょう。

今回は.env.exampleファイルをコピーする例で説明していきます。

それでは、下記のコマンドをプロジェクトディレクトリ下で実行して、.env.exampleファイルを.envファイルとして作成していきましょう。

$ cp .env.example .env

これでプロジェクトディレクトリに.envファイルが作成されました。

.envファイルの編集

次に、.envファイルに記述してあるDBとの接続情報などを変更していきます。
それでは、.envファイル内のDB情報を下記の通り編集してください。

DB_HOST=mysql
REDIS_HOST=redis
MAIL_FROM_ADDRESS=hoge@example.com

PHPのパッケージインストール

下記のコマンドを実行して、PHPのパッケージをインストールしてください。
※ 5行で1つのコマンドになっているので気をつけてください。

$ docker run --rm \
  -v $(pwd):/opt \
  -w /opt \
  laravelsail/php81-composer:latest \
  bash -c "composer install"

Dockerのコンテナ起動

下記コマンドでDockerのコンテナを起動させていきます。

$ ./vendor/bin/sail up -d

APP_KEYの生成

Laravelが暗号化やパスワードリセットといった、セキュリティ的に最重要な箇所で利用するAPP_KEYの生成を行います。
下記コマンドを実行して、APP_KEYを生成してください。

$ ./vendor/bin/sail artisan key:generate

npm install && npm run dev

Laravelの開発ではNode.jsでフロント側のパッケージなどを管理していることが多いので、下記コマンドを実行してパッケージのインストールとフロントのビルドを行ってください。

$ ./vendor/bin/sail npm install && ./vendor/bin/sail npm run dev

マイグレーション

下記のコマンドでマイグレーションをして、テーブルなどの作成をしてください。
なお、--seedを最後に付けることで、マイグレーションとともにシーディングもしてくれるので、マイグレーションとテストデータ作成を一度に行ってくれます。

また、1つ前のステップでnpm run devのコマンドを実行しているため、ターミナルにコマンドが入力できないようになっていると思います。
その場合は別タブを開いて下記のコマンドを実行してください。

$ ./vendor/bin/sail artisan migrate --seed

動作確認

これでLaravel sailのプロジェクトをクローンした際に、実際に開発できるようにするための準備は終了です。
さっそくlocalhostにアクセスして、エラーが出ていないかを確認してください！

下記のようなLaravelのウェルカムページやクローンしたプロジェクトのページが表示されればOKです！

最後に

Laravel sailのプロジェクトの場合、通常のLaravelをクローンした際と少しだけセットアップ方法が違うため記事にしてみました。

少しでも皆さんのLaravel開発ライフが充実することを願っています！

記事を最後までお読みいただき、ありがとうございました！