Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

mage-wizard

Package Overview
Dependencies
Maintainers
1
Versions
23
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

mage-wizard

Web UI wizard for Magento 2 providing useful features: module creation, config management, etc.

  • 0.2.19
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
26
increased by271.43%
Maintainers
1
Weekly downloads
 
Created
Source

Mage Wizard


📖 Documentation

[!WARNING] Mage Wizard is currently in beta. Use carefully in a development environment. Always work on version-controlled code, or backup your code before making changes. Please report any issues you find, or any suggestions you have.

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

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.

[!NOTE]
Remember to frequently run docker pull clickandmortar/mage-wizard to get the latest version.

Installing globally using npm

npm install -g mage-wizard

mage-wizard

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

Environment variables

NameDescriptionDefault value
PORTPort to listen on3000
HOSTHost to listen on127.0.0.1

Development

Requirements

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 --follow-tags origin main

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

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.

Keywords

FAQs

Package last updated on 17 May 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc