Edmonds Commerce Magento 2 Challenge Template

This is a template repository that you can use to help complete the Edmonds Commerce Magento Challenge.

It is set up to allow various tests and checks to run each time you push a commit.

Pre-requisites

Whilst you can complete this challenge in any of the three main operating systems, we recommend that Linux is used. Internally at Edmondscommerce we use Fedora as our preferred Linux distribution.

Docker and Docker compose (for Windows, Mac or Linux).

• Install Linux Docker Engine
• Install Linux Docker Compose Plugin
• Windows
• Mac

Note: You must install the Docker Compose plugin or equivalent for your operating system

Setting up the repo

To use the template - click the green Use this template button at the top of the page.

Give the repository a descriptive name, mark it as Private, and click the Create repository from template button

In order to get the tests to run, we need to be able to clone code down from the Magento repositories. To do this we need a username and password to use with composer.

To handle this you need to do the following:

• Get your authentication keys, Magento provides instructions here
• Create new secrets for the repository, GitHHub provides instructions here
• You need to create two secrets:
  • MAGENTO_USERNAME should be the Public key from Magento
  • MAGENTO_PASSWORD should be the Private key from Magento
• Copy the auth.json.sample to auth.json and replace the placeholders with your Magento username and password
• Copy app/etc/env.sample.php to app/etc/env.php
• Startup the containers docker-compose up -d
• Install dependencies with Composer
  • Shell into the container docker-compose exec app bash
  • Run composer install
• Setup the database
  • Run php bin/magento module:enable --all to create the initial config.php file
  • Run php bin/magento setup:upgrade to install magento and the sample data

Magento will be setup with sample data and can be accessed at https://localhost:8008 with a self-signed certificate. Admin is accessible at https://localhost:8008/admin with a username of admin and password 123123q

Once this is done you should be able the see the tests run in the Actions tab of the repo.

Completing the Challenge

As you add the code for the challenge, it is recommended to commit and push frequently to pick up anything that needs to be updated as you go, rather than waiting until the end to fix any issues.

Once you have completed all the tasks for the challenge, please make sure that the tests are passing, and then share the repository with @edmondscommerce and let us know.

Good Luck!