{"id":19783176,"url":"https://github.com/edmondscommerce/magento2-challenge-template","last_synced_at":"2025-06-27T17:35:57.433Z","repository":{"id":66730434,"uuid":"500888710","full_name":"edmondscommerce/magento2-challenge-template","owner":"edmondscommerce","description":"A template repository for the Magento 2 Challenge","archived":false,"fork":false,"pushed_at":"2023-03-21T17:15:44.000Z","size":35336,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-28T13:08:10.978Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"osl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/edmondscommerce.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"COPYING.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-07T15:02:59.000Z","updated_at":"2022-06-07T16:17:43.000Z","dependencies_parsed_at":"2023-07-11T10:02:59.157Z","dependency_job_id":null,"html_url":"https://github.com/edmondscommerce/magento2-challenge-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/edmondscommerce/magento2-challenge-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edmondscommerce%2Fmagento2-challenge-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edmondscommerce%2Fmagento2-challenge-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edmondscommerce%2Fmagento2-challenge-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edmondscommerce%2Fmagento2-challenge-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/edmondscommerce","download_url":"https://codeload.github.com/edmondscommerce/magento2-challenge-template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edmondscommerce%2Fmagento2-challenge-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262302514,"owners_count":23290277,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T06:07:29.427Z","updated_at":"2025-06-27T17:35:57.387Z","avatar_url":"https://github.com/edmondscommerce.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Edmonds Commerce Magento 2 Challenge Template\n\nThis is a template repository that you can use to help complete the [Edmonds Commerce Magento\nChallenge](https://www.edmondscommerce.co.uk/handbook/Platforms/Magento-2/Challenge/Magento-2-Challenge/).\n\nIt is set up to allow various tests and checks to run each time you push a commit.\n\n## Pre-requisites\n\nWhilst you can complete this challenge in any of the three main operating systems, we recommend that Linux is used.\nInternally at Edmondscommerce we use Fedora as our preferred Linux distribution.\n\nDocker and Docker compose (for Windows, Mac or Linux).\n* [Install Linux Docker Engine](https://docs.docker.com/engine/install/)\n* [Install Linux Docker Compose Plugin](https://docs.docker.com/compose/install/linux/)\n* [Windows](https://docs.docker.com/desktop/install/windows-install/)\n* [Mac](https://docs.docker.com/desktop/install/mac-install/)\n\n**Note: You must install the Docker Compose plugin or equivalent for your operating system**\n\n## Setting up the repo\n\nTo use the template - click the green `Use this template` button at the top of the page.\n\nGive the repository a descriptive name, mark it as Private, and click the `Create repository from template` button\n\nIn order to get the tests to run, we need to be able to clone code down from the Magento repositories. To do this we\nneed a username and password to use with composer.\n\nTo handle this you need to do the following:\n\n* Get your authentication keys, [Magento provides instructions\n  here](https://devdocs.magento.com/guides/v2.4/install-gde/prereq/connect-auth.html)\n* Create new secrets for the repository, [GitHHub provides instructions\n  here](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository)\n* You need to create two secrets:\n    - `MAGENTO_USERNAME` should be the Public key from Magento\n    - `MAGENTO_PASSWORD` should be the Private key from Magento\n* Copy the auth.json.sample to auth.json and replace the placeholders with your Magento username and password\n* Copy `app/etc/env.sample.php` to `app/etc/env.php`\n* Startup the containers `docker-compose up -d`\n* Install dependencies with Composer\n    - Shell into the container `docker-compose exec app bash`\n    - Run `composer install`\n* Setup the database\n    - Run `php bin/magento module:enable --all` to create the initial config.php file\n    - Run `php bin/magento setup:upgrade` to install magento and the sample data\n\nMagento will be setup with sample data and can be accessed at [https://localhost:8008]() with a self-signed certificate.\nAdmin is accessible at [https://localhost:8008/admin]() with a username of `admin` and password `123123q`\n\nOnce this is done you should be able the see the tests run in the Actions tab of the repo.\n\n## Completing the Challenge\n\nAs you add the code for the challenge, it is recommended to commit and push frequently to pick up anything that needs to\nbe updated as you go, rather than waiting until the end to fix any issues.\n\nOnce you have completed all the tasks for the challenge, please make sure that the tests are passing, and then share the\nrepository with @edmondscommerce and let us know.\n\nGood Luck!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedmondscommerce%2Fmagento2-challenge-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fedmondscommerce%2Fmagento2-challenge-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedmondscommerce%2Fmagento2-challenge-template/lists"}