madock

command module
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 2, 2022 License: MIT Imports: 6 Imported by: 0

README

madock

Local development environment based on Docker for Magento

Description

madock is a local Docker-based environment that allows you to run Magento2 projects. This project is written on Golang and it is distributed under a MIT License.

Key Features

  • Automatic project setup
  • Two or more projects can work simultaneously
  • Cron support
  • Flexible configuration for each project
  • Database import and export in two clicks
  • Simple viewing of logs with one command
  • Debug support
  • Synchronization of the local database and media files with the dev site

Tested on

  • Linux (Ubuntu 20.04)
  • macOS (Monterey)

Installation

You need 5 things on your local machine: git, docker, docker-compose, golang and madock

Follow the installation steps for your system.

Mac
  1. Install Docker
  2. Install Golang
  3. Install Mutagen
  4. Clone this repo and follow into folder "madock"
git clone git@github.com:faradey/madock.git

If you got error "git@github.com: Permission denied (publickey)." see solution 5. Compile

Run command below for Apple M1

GOARCH=arm64 go build -o madock
Run command below for Apple Intel

go build -o madock
  1. Add madock bin into your $PATH
ln -s absolute_path_to_your_madock_dir/madock /usr/local/bin/
  1. Open a new terminal tab/window and check that madock works
which madock
madock
  1. Optionally you can also apply these performance tweaks
Linux
  1. Install docker
  2. Configure permissions
  3. Install Docker-compose
  4. Install Golang
  5. Clone this repo and follow into folder "madock"
git clone git@github.com:faradey/madock.git

If you got error "git@github.com: Permission denied (publickey)." see solution 6. Compile

go build -o madock
  1. Add madock bin into your $PATH
ln -s absolute_path_to_your_madock_dir/madock /usr/local/bin/
  1. Open a new terminal tab/window and check that madock works
which madock
madock

Project Setup

cd <your_project>
madock setup

Usage

Start Application
madock start
madock composer install
sudo vim /etc/hosts
// Add -> 127.0.0.1 <your-domain>
Workflow

See detailed documentation about development workflow with madock

More Documentation

Donations

If you find it useful and want to invite us for a beer, just click on the donation button. Thanks!

Resources

This project has been possible thanks to the following resources:

License

(c) faradey

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL