clickandmortar/mage-wizard repository overview

⁠Mage Wizard

Mage Wizard is a web-based tool to help you developer faster on Magento / Adobe Commerce 2.4+:

• Generate a new module
• Generate / edit code:
  • System configs
  • Models
  • Patches
  • Commands
  • Crontab jobs
  • Admin grids (coming soon)
  • Plugins
  • Observers
  • Email templates
• View configuration:
  • Modules
  • Tables (from db_schema.xml)
  • Crontab jobs
  • CLI commands
  • Plugins
  • Observers
  • Email templates
• Analyse Composer dependencies

⁠Local requirements

• Node.js⁠ (18.x or newer)
• Magento / Adobe Commerce⁠ (2.4.x or newer)

⁠Usage

⁠Using npx

npx mage-wizard@latest

Open http://localhost:3000⁠ in your browser.

⁠Using Docker

docker run -p 3000:3000 -v <path-to-magento-root>:/magento clickandmortar/mage-wizard

Replace <path-to-magento-root> with the path to your Magento / Adobe Commerce root directory.

Open http://localhost:3000⁠ in your browser, and when prompted, use /magento as the Magento root path.

⁠Installing globally using npm

npm install -g mage-wizard

mage-wizard

Open http://localhost:3000⁠ in your browser.

⁠Environment variables

⁠Development

⁠Requirements

• npm⁠

⁠Setup

npm install

⁠Development server

Start the development server on http://localhost:3000:

npm run dev

⁠Build and deployment

# Bumps the version in package.json and creates a new commit with updated CHANGELOG.md
npm run release

git push origin <tag>

When a tag is pushed, the GitHub Actions workflow will:

• Build and deploy the package to npm⁠: see .github/workflows/npm.yaml⁠
• Build and push the Docker image to Docker Hub⁠: see .github/workflows/docker.yaml⁠

⁠Documentation

The documentation (located under docs/) is written in Markdown and rendered using VitePress⁠.

To start the documentation server locally, run:

npm run docs:dev

⁠Publishing the documentation

The documentation is automatically published to mage-wizard.dev⁠ using GitHub Pages.

See the .github/workflows/docs.yaml⁠ workflow for more details.

⁠License

This project is licensed under the MIT License - see the LICENSE⁠ file for details.

This project is not affiliated with, endorsed by, or sponsored by Adobe Inc. "Magento" and "Adobe Commerce" are trademarks of Adobe Inc. All trademarks and registered trademarks are the property of their respective owners.