【簡易版】Laravelインストール手順, GitHubへの反映

【簡易版】Laravelインストール手順, GitHubへの反映

4月 4, 2022

業務でLaravelの開発環境の構築をする機会が巡ってきたたため、備忘録としてインストール手順を遺しておこうと思います。「laravel インストール」などでGoogle先生に尋ねると数多くの先人達の記事に触れられる時代なので今更感は拭えませんが…

あくまで備忘録的な立ち位置なので簡易的な説明になりますのでその点はご容赦ください。

Composer インストール


既に別プロジェクトでLaravel開発を行っていることもあり、今回はComposerを利用してインストールを進めていきます。

ちなみに、ComposerはPHPにおけるパッケージ管理システムです。
複数人で開発を行うプロジェクト下において、開発の助けとなるパッケージの採用は個人の範囲ではなく、チームの範囲で管理するのが好ましく、その際にComposerをはじめとするパッケージ管理システムは有効です。

加えて、パッケージ間の依存関係もよしなにインストールしてくれるため、パッケージ導入のハードルを下げてくれるツールでもあります。

Composerのインストールは以下ダウンロートページからどうぞ。

A Dependency Manager for PHP
getcomposer.org

インストール後にターミナルにて以下コマンドを叩き

composer -v

バージョン情報が表示されていればインストールは成功です。

Laravel インストール


ここからは本題のLaravelインストール手順になります。

Laravelプロジェクト作成

今回のLaravelプロジェクト作成コマンドは以下。

composer create-project laravel/laravel SampleProject --prefer-dist "9.*"

意識する点としては –prefer-distオプションバージョン指定くらいでしょうか。

–prefer-distオプションを付与することで圧縮版を利用したダウンロードを行うため、gitのソース経由でダウンロードを行う–prefer-sourceオプション(–prefer指定なしの場合はこちらがデフォルト)よりも高速です。

バージョン指定については、利用したいバージョンがある場合は指定しましょう。
指定なしの場合は最新版がインストールされます。

今回は2022年2月にリリースされた最新のLaravel9を利用したいため、明示的に指定しています。

Laravel is a PHP web application framework with expressive, elegant syntax. We’v…
laravel.com

ビルトインサーバーの起動

残すは動作確認です。
Laravelではアプリケーションテストを目的とした開発(ビルトイン)サーバーを起動することが可能です。
(厳密にはLaravelの機能ではなく、PHPの機能になります)

ビルトインサーバーの起動コマンドは以下です。

php artisan serve

このコマンドによりlocalhostの8000番ポートでサーバーが起動します。

Starting Laravel development server: http://127.0.0.1:8000

ログに表示される http://127.0.0.1:8000 へアクセスするとLaravelのデフォルトページを参照することが可能です。

既存のLaravelプロジェクトをGitHub等からcloneする場合

自身でプロジェクト作成する場合ではなく、GitHub等で管理されているLaravelプロジェクトをcloneする場合には動作確認までに必要な作業が異なります。

一応、参考程度にまとめておきます。

.envファイルの作成

Laravelには環境設定を担う.envファイルが存在します。

自身でプロジェクトを作成した場合は.envも同時に生成されますが、既存プロジェクトをgit cloneした場合は作成する必要があり、これを行わずにビルトインサーバーで動作確認を行おうとするとHTTPステータス500が返されます。

作成といっても、プロジェクト作成時に生成される.env.exampleファイルを.envファイルとしてコピーするだけです。

cd SampleProject
cp .env.example .env

アプリケーションキーの生成

さらに、.envファイルを用意しただけではLaravelから以下のエラーが返されます。

No application encryption key has been specified.
つまり「アプリケーションの暗号化キーが設定されていない」ということになります。

Laravelにはアプリケーションキーを指定してあげる必要があり、こちらも.envと同様に自身でプロジェクト作成した場合には生成されますが、git clone経由では別途生成する必要があります。

とはいえ難しい作業は特になく、以下のコマンドを叩けば終了です。

php artisan key:generate

このコマンドにより、.env内のAPP_KEYに暗号化キーがセットされます。
プロジェクトによってはより詳細な環境設定を行う必要がありますが、基本的にはここまでの作業を行えばビルトインサーバーでの確認が行えるかと思います。

GitHubでの管理


最後に、自身で作成したLaravelプロジェクトをGitHubのリポジトリ上にpushする作業まで行います。
(gitlab等でも基本的には同様です)

先ずはGitHub等のバージョン管理システム側にリポジトリを作成しておいてください。
この作業はググればすぐ出てくるのでここでは割愛します。

先ほどまでに作成したLaravelプロジェクトのプロジェクトルート(例ではSampleProject直下)に移動しGitリポジトリとして初期化を行います。

git init

そして

git add . //ファイルをインデックス追加(コミット対象に)
git commit -m "Initial Commit" //コミット(メッセージは任意)
git remote add origin https://github.com/username/repositoryname.git //ローカルリポジトリにリモートリポジトリを追加
git push -u origin master //リモートリポジトリへのプッシュ

これでGitHub等のリモートリポジトリにLaravelプロジェクトを反映させることができました。
ここまでが簡易的なLaravel導入の手順になります。