Skip to content

Commit

Permalink
Update installation notes
Browse files Browse the repository at this point in the history
  • Loading branch information
mischabraam committed Oct 31, 2023
1 parent 59a3efd commit bf0cac5
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 10 deletions.
42 changes: 32 additions & 10 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,38 @@ 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 [email protected]
brew link [email protected] --force
brew services restart [email protected]
```

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, use `--help` to see all installation options.
```shell
valet-plus install
```

The daemons Valet+ depends on will be configured to launch when your system starts. 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 [email protected] first before installing Valet+.
> You can do this with the following commands.
> ```shell
> brew install [email protected]
> brew link [email protected] --force
> brew services restart [email protected]
> ```


## Valet+ features
Expand Down Expand Up @@ -52,9 +74,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

Expand Down
3 changes: 3 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@
"WeProvide\\ValetPlus\\": "cli/ValetPlus/"
}
},
"config": {
"platform-check": false
},
"require": {
"php": ">=7.1 <8.3",
"laravel/valet": "^4.1"
Expand Down

0 comments on commit bf0cac5

Please sign in to comment.