{"id":25217698,"url":"https://github.com/dnunez24/magento2ce-starter","last_synced_at":"2025-09-14T22:20:34.337Z","repository":{"id":141382847,"uuid":"67046222","full_name":"dnunez24/magento2ce-starter","owner":"dnunez24","description":"Starter environment for Magento 2 demo and development using Docker and Docker Compose","archived":false,"fork":false,"pushed_at":"2017-03-08T15:17:07.000Z","size":68,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-03T15:28:36.073Z","etag":null,"topics":["magento","magento2","magento2-docker-environment","project","template"],"latest_commit_sha":null,"homepage":"http://davidanunez.com/magento2ce-starter/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dnunez24.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-08-31T14:44:02.000Z","updated_at":"2018-04-30T15:37:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"7d91153b-baa6-416e-bc4b-ed8a87eede82","html_url":"https://github.com/dnunez24/magento2ce-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dnunez24/magento2ce-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dnunez24%2Fmagento2ce-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dnunez24%2Fmagento2ce-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dnunez24%2Fmagento2ce-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dnunez24%2Fmagento2ce-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dnunez24","download_url":"https://codeload.github.com/dnunez24/magento2ce-starter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dnunez24%2Fmagento2ce-starter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260481760,"owners_count":23015802,"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":["magento","magento2","magento2-docker-environment","project","template"],"created_at":"2025-02-10T20:52:16.041Z","updated_at":"2025-09-14T22:20:34.325Z","avatar_url":"https://github.com/dnunez24.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Magento 2 Project Starter\n\n## Requirements\n\n* Docker for Mac (\u003e= 1.12.x)\n* Docker Compose\n\n## Setup\n\n```bash\ngit clone https://github.com/dnunez24/magento2-docker-starter.git my-project\ncd my-project\n\n```\n\nModify the `.env` file to provide environment variables to Docker Compose\n\n### Existing Database\n\nTo use an existing Magento 2 database, copy a MySQL dump file into the project directory and uncomment the SQL import line for the `db` service in the `docker-compose.yml` file.\n\n```bash\ncp $HOME/my-magento-data.sql.gz conf/data.sql.gz\n```\n\n### Start the Services\n\n```bash\n# Start the Docker Compose environment\ndocker-compose up -d\n```\n\n## Install Magento\n\nIf you didn't already use existing data in the last step...\n\n```bash\n# Installs without enterprise args by default\nbin/install\n```\n\n### Install Sample Data (optional)\n\n```bash\nbin/magento sampledata:deploy\nbin/magento setup:upgrade\nbin/magento setup:di:compile\nbin/magento indexer:reindex\nbin/magento cache:flush\n```\n\n## Develop\n\nAdd your theme, module or language pack to `src` directory.\n\n```bash\nmkdir src/module-my-feature\n```\n\nAdd your local module directory as a Composer repository with the `path` type.\n\n```bash\ncomposer config repositories.my-feature path ./src/module-my-feature\n```\n\nAdd a `composer.json` file to your module directory.\n\n```bash\ntouch src/module-my-feature/composer.json\n```\n\n[Configure your component](http://devdocs.magento.com/guides/v2.1/extension-dev-guide/package/package_module.html) in the `composer.json` file you created. Its contents should look something like the following:\n\n```json\n{\n    \"name\": \"my-vendor/module-my-feature\",\n    \"description\": \"Some new feature\",\n    \"type\": \"magento2-module\",\n    \"version\": \"dev-master\",\n    \"license\": [\n        \"OSL-3.0\",\n        \"AFL-3.0\"\n    ],\n    \"require\": {\n        \"php\": \"~5.5.0|~5.6.0|~7.0.0\",\n        \"magento/magento-composer-installer\": \"*\",\n        \"magento/framework\": \"100.1.*\"\n    },\n    \"autoload\": {\n        \"files\": [\n            \"registration.php\"\n        ],\n        \"psr-4\": {\n            \"MyVendor\\\\MyFeature\\\\\": \"\"\n        }\n    }\n}\n```\n\nAdd your `registration.php` file for Composer autoloading.\n\n```bash\ntouch src/module-my-feature/registration.php\n```\n\nConfigure your module registration. It should look something like the following:\n\n```php\n\u003c?php\n\nuse \\Magento\\Framework\\Component\\ComponentRegistrar;\n\nComponentRegistrar::register(\n    ComponentRegistrar::MODULE,\n    'MyVendor_MyModule',\n    __DIR__\n);\n\n```\n\nRequire your module through Composer.\n\n```bash\ncomposer require my-vendor/module-my-feature:dev-master\n```\n\nThe project root level `composer.json` should then look something like the following:\n\n```json\n\"require\": {\n    \"composer/composer\": \"@alpha\",\n    \"magento/magento-composer-installer\": \"*\",\n    \"magento/product-community-edition\": \"2.1.4\",\n    \"my-vendor/module-my-feature\": \"dev-master\"\n},\n```\n\nEnable and set up your module in Magento.\n\n```bash\nbin/magento module:enable MyVendor_MyFeature\nbin/magento setup:upgrade\n```\n\n## Linting \u0026 Testing\n\n### Linting\n\nYou can manually run static analysis tools during development\n\n```bash\nphpcs\n```\n\nOr, better yet, configure your editor to support on-the-fly linting. Here are some resources for common editors:\n\n[Atom](https://atom.io/packages/linter)  \n[Sublime Text](http://www.sublimelinter.com/en/latest/)  \n[PHP Storm](https://www.jetbrains.com/help/phpstorm/2016.3/using-php-code-sniffer-tool.html)  \n[Vim](https://github.com/bpearson/vim-phpcs)  \n\n## Testing\n\nTODO\n\n## Roadmap\n\n* [ ] Add HTTPS capability and docs\n* [ ] Configure Behat bootstraps for Magento 2 testing\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdnunez24%2Fmagento2ce-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdnunez24%2Fmagento2ce-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdnunez24%2Fmagento2ce-starter/lists"}