{"id":13365913,"url":"https://github.com/clickAndMortar/mage-wizard","last_synced_at":"2025-03-12T17:32:02.129Z","repository":{"id":203751148,"uuid":"684635124","full_name":"ClickAndMortar/mage-wizard","owner":"ClickAndMortar","description":"Develop faster on Magento / Adobe Commerce with Mage Wizard","archived":false,"fork":false,"pushed_at":"2024-05-17T08:57:25.000Z","size":5969,"stargazers_count":17,"open_issues_count":6,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-07T03:06:09.127Z","etag":null,"topics":["adobe-commerce","magento","php"],"latest_commit_sha":null,"homepage":"https://mage-wizard.dev/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ClickAndMortar.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}},"created_at":"2023-08-29T14:42:03.000Z","updated_at":"2025-03-07T01:39:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"c984fbef-cec5-42fe-bdb3-f0baa472ca3e","html_url":"https://github.com/ClickAndMortar/mage-wizard","commit_stats":null,"previous_names":["clickandmortar/mage-wizard"],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ClickAndMortar%2Fmage-wizard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ClickAndMortar%2Fmage-wizard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ClickAndMortar%2Fmage-wizard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ClickAndMortar%2Fmage-wizard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ClickAndMortar","download_url":"https://codeload.github.com/ClickAndMortar/mage-wizard/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243262201,"owners_count":20262965,"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":["adobe-commerce","magento","php"],"created_at":"2024-07-30T00:01:16.256Z","updated_at":"2025-03-12T17:32:01.568Z","avatar_url":"https://github.com/ClickAndMortar.png","language":"TypeScript","funding_links":[],"categories":["Tools"],"sub_categories":["Meet Magento"],"readme":"# Mage Wizard\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/ClickAndMortar/mage-wizard/main/public/favicon.png\"\u003e\n\u003c/p\u003e\n\n---\n\n\u003cdiv align=\"center\"\u003e\n📖 \u003ca href=\"https://mage-wizard.dev\"\u003e\u003cstrong\u003eDocumentation\u003c/strong\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n---\n\n\u003e [!WARNING]\n\u003e Mage Wizard is currently in beta. Use carefully in a development environment.\n\u003e Always work on version-controlled code, or backup your code before making changes.\n\u003e Please report any issues you find, or any suggestions you have.\n\nMage Wizard is a web-based tool to help you developer faster on Magento / Adobe Commerce 2.4+:\n\n* Generate a new module\n* Generate / edit code:\n  * System configs\n  * Models\n  * Patches\n  * Commands\n  * Crontab jobs\n  * Admin grids (coming soon)\n  * Plugins\n  * Observers\n  * Email templates\n* View configuration:\n  * Modules\n  * Tables (from `db_schema.xml`)\n  * Crontab jobs\n  * CLI commands\n  * Plugins\n  * Observers\n  * Email templates\n* Analyse Composer dependencies\n\n## Local requirements\n\n- [Node.js](https://nodejs.org/en/) (`18.x` or newer)\n- [Magento / Adobe Commerce](https://magento.com/) (`2.4.x` or newer)\n\n## Usage\n\n### Using npx\n\n```shell\nnpx mage-wizard@latest\n```\n\nOpen http://localhost:3000 in your browser.\n\n### Using Docker\n\n```shell\ndocker run -p 3000:3000 -v \u003cpath-to-magento-root\u003e:/magento clickandmortar/mage-wizard\n```\n\nReplace `\u003cpath-to-magento-root\u003e` with the path to your Magento / Adobe Commerce root directory.\n\nOpen http://localhost:3000 in your browser, and when prompted, use `/magento` as the Magento root path.\n\n\u003e [!NOTE]  \n\u003e Remember to frequently run `docker pull clickandmortar/mage-wizard` to get the latest version.\n\n### Installing globally using npm\n\n```shell\nnpm install -g mage-wizard\n\nmage-wizard\n```\n\nOpen http://localhost:3000 in your browser.\n\n\n### Environment variables\n\n| Name   | Description       | Default value |\n|--------|-------------------|---------------|\n| `PORT` | Port to listen on | `3000`        |\n| `HOST` | Host to listen on | `127.0.0.1`   |\n\n## Development\n\n### Requirements\n\n- [npm](https://npmjs.com/)\n\n### Setup\n\n```bash\nnpm install\n```\n\n### Development server\n\nStart the development server on `http://localhost:3000`:\n\n```bash\nnpm run dev\n```\n\n## Build and deployment\n\n```shell\n# Bumps the version in package.json and creates a new commit with updated CHANGELOG.md\nnpm run release\n\ngit push --follow-tags origin main\n```\n\nWhen a tag is pushed, the GitHub Actions workflow will:\n\n* Build and deploy the package to [npm](https://www.npmjs.com/package/mage-wizard): see [`.github/workflows/npm.yaml`](.github/workflows/npm.yaml)\n* Build and push the Docker image to [Docker Hub](https://hub.docker.com/r/clickandmortar/mage-wizard): see [`.github/workflows/docker.yaml`](.github/workflows/docker.yaml)\n\n## Documentation\n\nThe documentation (located under `docs/`) is written in Markdown and rendered using [VitePress](https://vitepress.dev/).\n\nTo start the documentation server locally, run:\n\n```shell\nnpm run docs:dev\n```\n\n### Publishing the documentation\n\nThe documentation is automatically published to [mage-wizard.dev](https://mage-wizard.dev) using GitHub Pages.\n\nSee the [`.github/workflows/docs.yaml`](.github/workflows/docs.yaml) workflow for more details.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\nThis project is not affiliated with, endorsed by, or sponsored by Adobe Inc.\n\"Magento\" and \"Adobe Commerce\" are trademarks of Adobe Inc.\nAll trademarks and registered trademarks are the property of their respective owners.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FclickAndMortar%2Fmage-wizard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FclickAndMortar%2Fmage-wizard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FclickAndMortar%2Fmage-wizard/lists"}