README

Introduction

Peach provides a local development experience based on Docker. No software or library needs to be installed locally before using Peach. Peach's simple CLI allows you to start building your application without any previous experience with Docker.

Inspiration

Peach is inspired by and derived from Sail, created by Taylor Otwell. For more information, check out the Sail repository.

Official Documentation

Install Peach using Composer:

composer require ysocode/peach --dev

Configure the services for Peach using the Basket Manager:

./vendor/bin/basket peach:install

Modify existing Peach services using the Basket Manager:

./vendor/bin/basket peach:add

Setting up a Shell Alias:

By default, Peach commands are invoked using the script vendor/bin/peach:

./vendor/bin/peach up

However, instead of typing vendor/bin/peach repeatedly to run Peach commands, you may want to set up a shell alias to make running Peach commands easier:

alias peach="[ -f peach ] && sh peach || sh vendor/bin/peach"

Starting and Stopping Peach:

Before starting Peach, make sure no other web server or database is running on your local machine. To start all Docker containers defined in your application's docker-compose.yml file, run the up command:

peach up

To start all Docker containers in the background, you can start Peach in "detached" mode:

peach up -d

Once the application's containers are up, you can access the project in your web browser at: http://localhost.

To stop all containers, you can press Control + C to interrupt the container's execution. If the containers are running in the background, you can use the stop command:

peach stop

To restart the containers, you can use the start command:

peach start

To stop and remove all containers, you can use the down command:

peach down

License

Peach is open-sourced software licensed under the MIT license.

ysocode / peach

Maintainers

Details