Project Onboarding

Local Development

Initial Setup

1. Clone https://github.com/magento-architects/storefront-cloud-project.git and switch to corresponding feature branch branch.
   1. Base branch is production
   2. Add environment variable GITHUB_TOKEN to access necessary repositories: export GITHUB_TOKEN=<your_token>
2. Follow https://devdocs.magento.com/cloud/docker/docker-mode-developer.html instructions to generate the project and start DevBox.
   1. Skip step 1 about "application template".
   2. auth.json is not needed for ECP project, skip this step.
   3. Make sure Docker has at least 6GB of RAM
   4. For composer install
      1. Using --ignore-platform-reqs is ok on this stage if not all requirements are covered. Purpose of this step is to install ece-tools, so platform requirements should satisfy at least ece-tools. This step will clone all specified Magento repos (see .magento.env.yaml or composer.json), this may take a while.
   5. Summary of the steps:

composer install
./vendor/bin/ece-docker build:compose --mode=developer --sync-engine=mutagen --with-cron
docker-compose up -d
./mutagen.sh
 
# wait for files to sync or next steps can fail
 
docker-compose run deploy cloud-deploy
docker-compose run deploy cloud-post-deploy

3. Add "127.0.0.1 magento2.docker" to hosts file

Magento should be available at https://magento2.docker/