From a783b7108d6fe00e68b7e1bafd6a331ef3adf917 Mon Sep 17 00:00:00 2001 From: Mischa Braam Date: Tue, 31 Oct 2023 11:16:35 +0100 Subject: [PATCH] Update installation notes --- README.MD | 41 +++++++++++++++++++++++++++++++---------- composer.json | 3 +++ 2 files changed, 34 insertions(+), 10 deletions(-) diff --git a/README.MD b/README.MD index cff6354a..ff6c9d1d 100644 --- a/README.MD +++ b/README.MD @@ -7,16 +7,37 @@ Valet+ is a development environment for macOS. No Vagrant, no Docker, no `/etc/h ## Installation -This project uses [laravel/valet](https://github.com/laravel/valet) as a dependency. You can follow the installation -instructions of Laravel's Valet. +> :warning: Valet+ requires macOS and [Homebrew](https://brew.sh/). Before installation, you should make sure that no +> other programs such as Apache or Nginx are binding to your local machine's port 80. + +> :warning: Valet+ requires [Composer](https://getcomposer.org/) to be installed. + +To get started, you first need to ensure that Homebrew is up to date using the update command: +```shell +brew update +``` + +Next, you should use Homebrew to install PHP 8.0: +```shell +brew install php@8.0 +brew link php@8.0 --force +brew services restart php@8.0 +``` + +Install Valet+ 3.x-dev with composer: +```shell +composer global require weprovide/valet-plus:3.x-dev +``` + +Finally, you may execute the Valet+ `install` command. This will configure and install Valet+, Nginx, DnsMasq and other +services. In addition, the daemons Valet+ depends on will be configured to launch when your system starts: +```shell +valet-plus install +``` + +Once Valet+ is installed, try pinging any `*.test` domain on your terminal using a command such as `ping foobar.test`. +If Valet+ is installed correctly you should see this domain responding on `127.0.0.1`. -> Note: install php@8.0 first before installing Valet+. -> You can do this with the following commands. -> ```shell -> brew install php@8.0 -> brew link php@8.0 --force -> brew services restart php@8.0 -> ``` ## Valet+ features @@ -52,9 +73,9 @@ Here are a few key differences compared to the original Valet: ## Valet+ Authors +- Mischa Braam ([@mischabraam](https://github.com/mischabraam)) - Tim Neutkens ([@timneutkens](https://github.com/timneutkens)) - Sam Granger ([@samgranger](https://github.com/samgranger)) -- Mischa Braam ([@mischabraam](https://github.com/mischabraam)) ## Valet+ Contributors diff --git a/composer.json b/composer.json index d80e80b2..0da3f699 100644 --- a/composer.json +++ b/composer.json @@ -16,6 +16,9 @@ "WeProvide\\ValetPlus\\": "cli/ValetPlus/" } }, + "config": { + "platform-check": false + }, "require": { "php": ">=7.1 <8.3", "laravel/valet": "^4.1"