timrspratt/aero-docker

Docker Environment for Aero Commerce Stores

• Usage
• Prerequisites
• Setup
  • Global Command Installation
  • Project Setup & Installation
• Alternative Setup
  • Existing Project
• Available Commands
• License

Usage

This configuration is intended to be used as a Docker-based development environment for Aero Commerce stores.

Prerequisites

This setup assumes you are running Docker on a computer (the host machine). Download & Install Docker Desktop.

This configuration has been tested on Mac & Linux. Windows is supported through the use of Docker on WSL.

Setup

Global Command Installation

From command line, run the following command to register a global aero command:

curl -s https://raw.githubusercontent.com/timrspratt/aero-docker/1.x/install.sh | bash

Project Setup & Installation

Run the aero new command to start the installation. During the installation process, you'll need to provide project credentials, which can be obtained from Agora.

aero new {store_name}

You can pass options to this command to adjust the setup, for example:

• --php=8.3 – Change the PHP version
• --laravel=10 – Change the Laravel version
• --theme=aero/skeleton – Change the theme
• --catalog=furniture – Change the catalog industry to seed

Open your browser and navigate to http://localhost.

Alternative Setup

Existing Project

There may be a time you need to configure an existing project to run with Aero Docker. For example pulling a repository from GitHub to run locally that has not initially been configured using Aero Docker.

Run the aero setup command from within the root directory of the project.

aero setup

Available Commands

Run aero help to view a list of the available commands.

License

MIT License