Skip to content

Latest commit

 

History

History
347 lines (271 loc) · 15.7 KB

laravel-installation-windows.md

File metadata and controls

347 lines (271 loc) · 15.7 KB
Raw

Laravel 新PCでの開発環境構築 Windows11版

何もインストールしてない新しいWindows PCでLaravelの開発ができるまでの環境を作る。実際に新PCで作業しながら書いたので現時点では最善。

最終更新日：2024年4月 環境構築は「いつ」の情報かが重要なので更新日から何年も後に読んでも役に立たない。

更新履歴

  • 2024年4月：node.jsのインストール方法を更新。PHP8.3に更新。初版から時間が経ってきたのでそろそろ古くなってるかもしれない。これを読んでも分からない初心者はLaravel Herdを使うのがおすすめ。
  • 2023年10月：node.jsをInstallation Scriptsを使う方法に変更。
  • 2023年2月：データベースアプリ変更。

対象読者

プログラミング初心者は対象じゃない。Laravelは初心者が使うものじゃない。

すでにLaravelを使っていて大量のLaravelプロジェクトを抱えてる人が別の新しいPCでも開発する場合を想定。
職場と自宅、WindowsとMacなど複数のPCで併用する前提。
プロが対象なので有料のツールも遠慮なく含める。

Laravelを使う前に必須な知識

フレームワークとは「知識の下限を揃えるためのもの」。Laravelの公式ドキュメントはこのくらいは知ってるだろうという前提で進む。

  • 一般以上のPCスキル
  • Webに関する幅広い知識
  • 素のPHP。最新バージョンまで。composerとPSR。
  • git / GitHub
  • フロントエンドの知識。最低限node.js/npmや「JavaScriptもビルドして使うようになった」という現代の常識は必須。html→PHPと進んできた初心者が躓くのはフロントの知識が足りてないのが主な原因。
  • Linuxの知識。最低でも「php -vはターミナルで実行する」が分かる程度。

Chrome

https://www.google.com/intl/ja_jp/chrome/

細かいプラグインは同期すれば勝手にインストールされるので書かない。以降のアプリも同様。

GitHub Desktop

https://desktop.github.com/

SourceTree

https://www.sourcetreeapp.com/

GitHub Desktopだけでは足りないことがあるのでSourceTreeもインストール。

VS code

https://code.visualstudio.com/download

VS codeからWindows版gitのインストールを要求されるかもしれない。あまり使わないけど念のためインストール。
https://git-scm.com/downloads

PhpStorm

https://www.jetbrains.com/ja-jp/phpstorm/download/

普段の開発はPhpStormを使うけどちょっとした変更程度はVS codeを使うこともあるしGitHub上で直接変更することもある。

TablePlus

データベースアプリ https://tableplus.com/

接続の設定はSail用に共通で一つ作ればいい。

  • Host：127.0.0.1
  • Port：3306
  • ユーザーとパスワード：.envで設定したもの。sailとpassword
  • データベース：空

sail起動後に接続可能。データベースを指定しないことで大量のLaravelプロジェクトでも共通で使える。接続後に表示するデータベースの選択が必要。

Windows Subsystem for Linux

Microsoft Storeからインストール。

StoreからWSLをインストールしただけの段階ではwsl --versionでバージョンを表示できる。

wsl --version

WSL バージョン: 1.0.3.0
カーネル バージョン: 5.15.79.1
WSLg バージョン: 1.0.47
MSRDC バージョン: 
Direct3D バージョン: 
DXCore バージョン:
Windowsバージョン:

Windows Terminal(PowerShell)でwsl --install Ubuntuを実行。
ダウンロード後、Ubuntu用の新しいユーザー名とパスワードを決定。

Installing, this may take a few minutes...
Please create a default UNIX user account. The username does not need to match your Windows username.
For more information visit: https://aka.ms/wslusers
Enter new UNIX username: 
New password:
Retype new password:
passwd: password updated successfully
Installation successful!

以前と比べるとWSLのインストールもかなり簡単になっている。Laravelを使うならこのくらいはできて当然。

これ以降のコマンドはWSLのUbuntuで実行。
Windows Terminalの設定で既存のプロファイルをUbuntuにしておく。

WSLでのファイルの扱いを理解する

WSLを使っているとパーミッションのエラーに遭遇しやすい。「Windows側」なのか「WSLのUbuntu側」なのか常に意識してないと間違えやすい。

  • Windows側からWSL側のファイルへのアクセス：\\wsl$もしくは\\wsl.localhost\
  • WSL側からWindows側のファイル：/mnt/c/ /mnt/d/
  • WSL内：通常のUbuntuと同じ/ /home/

GitHub Desktopでgit cloneしたらcomposer installでエラーが出る時の修正方法

（WSLインストール直後に発生しやすいかも。一度再起動後に発生しなければ気にしなくていい）

前提。
WSLのUbuntuをインストール時に作った新しいユーザーをuserとするとWSL側のホームは/home/user/。
GitHubからcloneする作業場所を/home/user/GitHub/に作ったとする。

WSL側の/home/user/GitHub/はWindows側からは\\wsl.localhost\Ubuntu\home\user\GitHub\。
Windows側のGitHub Desktopで\\wsl.localhost\Ubuntu\home\user\GitHub\にcloneするとファイルの所有者がrootになっていてuserからは書き込みできないのでcomposer installでエラーが出る。

確認。rootがあれば所有者がroot。userなら問題ないので以降は不要。

cd ~/GitHub/
ll
... root root ...

修正方法はWSL側で/home/user/GitHub/内の所有者を変更する。

cd
sudo chown user.user -R ./GitHub/

修正した後の次からはWSL側でcloneすれば最初からuserなので再発しない。

cd ~/GitHub/
git clone ...

とはいえ普段はGitHub Desktop使いたいので面倒。エラーが出た時の修正方法さえ覚えておけばGitHub Desktopからでも大丈夫。

Docker Desktop

Dockerを使うためにはWSLが必須。
https://www.docker.com/products/docker-desktop/

Settings -> Resources -> WSL IntegrationでUbuntuを有効化。ここを設定しないとUbuntu内でdockerコマンドなどが使えない。

Enable integration with additional distros:

Ubuntu

WSLのUbuntu側にいろいろインストール

「開発環境は全部Docker内に閉じ込める」なんて現実的には机上の空論。そんな使い方は不便すぎるのでDocker外の手元でもphp,composer,npmくらいは使えるようにしておく。

この辺りはバージョンアップで変わるのでそのまま真似しない。

PHP

artisanやcomposerのためなのでcliだけでもいい。
SailのDockerfileを見て同じものをインストール。全部は不要なはずだけどcomposer install時に必要なこともあるので一応インストール。足りなければ後で追加。
https://github.com/laravel/sail/tree/1.x/runtimes

sudo apt-get install curl zip unzip
LC_ALL=C.UTF-8 sudo add-apt-repository ppa:ondrej/php
sudo apt-get install -y php8.3-cli php8.3-dev \
       php8.3-pgsql php8.3-sqlite3 php8.3-gd \
       php8.3-curl \
       php8.3-imap php8.3-mysql php8.3-mbstring \
       php8.3-xml php8.3-zip php8.3-bcmath php8.3-soap \
       php8.3-intl php8.3-readline \
       php8.3-ldap \
       php8.3-msgpack php8.3-igbinary php8.3-redis php8.3-swoole \
       php8.3-memcached php8.3-pcov php8.3-imagick php8.3-xdebug
php -v

composer install時にext-***が足りないみたいなエラーが出た時

sudo apt-get install php8.3-***

PhpStormでXdebugをオンデマンドモードで使う

https://pleiades.io/help/phpstorm/configuring-xdebug.html#on_demand_mode
Laravelではテストを書くのが普通で「ステップ実行」なんて全く使わない。なのでXdebugは普段は無効化、カバレッジ付きでテストを実行する時のみ有効にすればいい。この形で使うのが一番高速。

  • php --iniでphp.iniの場所を確認。PHP8.2なら/etc/php/8.2/cli/conf.d/20-xdebug.ini。;zend_extension=xdebug.soに変更して無効化。
    • PhpStormのインタープリター設定の「デバッガー拡張機能」にxdebug.soのパスを指定。ここはPHPのバージョンアップで変わる。例としてPHP8.2なら/usr/lib/php/20220829/xdebug.so

composer

必ずここからコピペする。 https://getcomposer.org/download/

// ダウンロードページでコピペしたインストールスクリプトを実行。

// composerだけで使えるように移動。
sudo mv composer.phar /usr/local/bin/composer
composer -V

composerをインストールしてないとgit clone後の初回インストールでDockerを使う必要がある。

docker run --rm -u "$(id -u):$(id -g)" -v "$(pwd):/var/www/html" -w var/www/html composer/composer:latest install --ignore-platform-reqs

これよりもPhpStormでインストールできたほうが楽。

laravel/installerをインストールするなら。最近はlaravel.build使うので入れなくてもいい。

composer global require laravel/installer

laravel

globalにインストールしたcomposerコマンドを使うために.bashrcでPATHの設定も必要。

export PATH=~/.composer/vendor/bin:$PATH

node.js

nodesourceからのインストール方法自体がたまに変わるので常にここを確認する。
https://github.com/nodesource/distributions

これはnode.js 21のインストールなので必ず↑を見て最新バージョンを入れる。

curl -fsSL https://deb.nodesource.com/setup_21.x | sudo -E bash - &&\
sudo apt-get install -y nodejs
node -v
npm -v

WSLに直接インストールする以外の方法も色々あるけどLaravelで使うならnpmを使うだけなのでこれで十分。

バージョンアップ作業

sudo apt update
sudo apt upgrade

composer selfupdate

sailコマンドのエイリアス登録

echo "alias sail='[ -f sail ] && sh sail || sh vendor/bin/sail'" >> ~/.bash_aliases

これでsailだけで使えるようになる。

sail version

使える場所はcomposer install済のLaravelプロジェクト直下。

基本の使い方1 既存のLaravelプロジェクト

GitHubにLaravelプロジェクトがある状態から開始。

先に：↑のほうの所有者の問題がなければGitHub Desktopからcloneしてもいい。これが一番簡単。保存先は必ずWSL側にする。

以降はターミナルからcloneする場合の話。

WSL側

cd ~/GitHub/
git clone https://.../test.git
cd test
composer install
cp .env.example .env
php artisan key:generate
# 必要なら.envを編集

npm install
npm run build

sail up -d

# migrateなどDBに接続するコマンドは必ずsail内で実行
sail art migrate
# 他のmakeコマンドなどはsail外で使ってもいい。Dockerを使わないので若干早いしsail起動前でも使える。
php artisan make:controller TestController

sail down

clone以降はすぐにPhpStormで開いて続きはPhpStormのターミナルやcomposer install機能を使ってもいい。
PhpStormでcomposerやnpmコマンドを使う場合、インタープリターの選択画面が出る。この時にWSL内のphpやnodeを使うように設定する。 https://pleiades.io/help/phpstorm/configuring-remote-interpreters.html

Windows側
GitHub Desktopにcloneしたフォルダを追加。
Add local repository -> Choose
この時普通にフォルダを選択しようとしても最初は出て来ないのでまず\\wsl$\Ubuntu\homeを表示してからcloneしたフォルダまで進める。
Windows側からWSLのファイルを読んでいるので追加時に警告が出るけど問題ないので「add an exception for this directory」を選んで進めて追加する。
PhpStormで開く時も同様。

PhpStormでコードを書いて、gitはGitHub Desktopを使う、コマンドはターミナル、といういつもの開発体制が整う。

composerやnpmのスクリプトはPhpStormから実行。
composer.jsonのscriptsにsailのupとdownを書いておけばsailの起動・終了もPhpStormからさっとできる。

        "sail:up": "./vendor/bin/sail up -d",
        "sail:down": "./vendor/bin/sail down",

もう一歩進めてsail up後にide-helper:modelsも実行。DBへの接続が必要なのでup直後に毎回実行が効率的。

        "sail:up": [
            "./vendor/bin/sail up -d",
            "./vendor/bin/sail art ide-helper:models -N"
        ],

基本の使い方2 Laravelプロジェクトを新規作成

Laravelのドキュメント通りなので変わった所はない。

cd ~/GitHub/
curl -s "https://laravel.build/example-app" | bash
cd example-app
sail up -d
sail down

PhpStormやGitHub Desktopの話は↑と同じ。

テスト

テストはWSLのphpとプロジェクトにインストールしたphpunitでPhpStormの機能で実行。カバレッジ付きで実行すればコードカバレッジの表示もできる。
毎年11月頃はPHPの新バージョンで動作確認するために「WSLのPHPは8.1のままsailのPHPだけ8.2RCにしてテスト」みたいなことをするのでsail testを使うこともある。

ポイント

  • Chrome, PhpStorm, GitHub Desktop, VS codeなどのアプリはWindows側で使う。
  • その他のファイルの置き場所、ターミナルでのコマンドの実行などはすべてWSL側。ファイルはWindows側に置いてもいいけど実際に使うと速度に差があってWSL側がいいと分かる。
  • WSLにインストールしたphp, composer, npmはすべてのLaravelプロジェクト共通で使う。installやupdateに使うだけなので常に最新バージョンでいい。プロジェクトごとの分離した環境はsailで作る。DBなどは分離。
  • PhpStormでインタープリターの選択が出てきたらWSLを使うように設定する。ここを徹底しないと上手く動かない。新しい環境では最初だけ色々設定が必要だけど落ち着いたら意識せず使えるようになる。
  • Windows環境ではWSLさえ使えれば困らない。WSLがなかった頃と比べると別世界。

余談：リモート開発

PhpStormを使うならここまでの使い方で十分だけどPhpStormにもVS codeにもリモート開発機能がある。VS codeをメインに使っていくならリモート開発を使ったほうがいい。

余談：初心者がやりがちだけどやってはいけないこと

  • XAMPP, phpMyAdminなどは「初心者が書いた間違った本やブログ」に騙された初心者がインストールしようとするけどLaravelユーザーが使うことはないので一切不要。
  • Dockerコンテナ内で作業しない。sail登場前からDockerやHomestead(Vagrant)の内部に入ってコマンドを実行する使い方してる初心者が多い。これやると普段使ってるターミナルとは別の環境で作業することになるのでとても不便。考え方が逆。コンテナの外の使い慣れたターミナルからコンテナ内のコマンドを実行する使い方をすべき。Laravel公式のsailはこの辺り良く分かっていてsail artisan ...はコンテナの外で実行。コンテナ内で何か作業することは全くない。