Getting Started

Prerequisites

Docker and Docker Compose. Mutagen to improve performance because Docker can be painfully slow on macOS with some projects. mkcert (optional) to make locally trusted development certificates because HTTPS has become the norm. Last but not least, this package currently only supports macOS.

Installing

You can install origami with Composer like any PHP dependency.

composer global require ajardin/origami

Make sure your Composer global vendor binaries directory is in your $PATH environment variable.

export PATH="$(composer global config bin-dir --absolute --quiet):$PATH"

Once you have installed the binary, you can check the status of the application requirements.

origami --verbose

• Docker and Docker Compose.
• Mutagen to improve performance because Docker can be painfully slow on macOS with some projects.
• OrbStack to install Docker and Docker Compose with some performance tweaks.
• mkcert (optional) to make locally trusted development certificates because the HTTPS has become the norm.

Last but not least, this package currently only supports macOS.

Usage

1. Open a terminal in the directory of your project
2. Run origami install
3. Configure the environment of your choice
4. Run origami start
5. Open your favourite browser on https://localhost/

The var/docker/ directory of your project contains the environment configuration. Feel free to edit it at your convenience; it is your configuration now. 😉