MageForge for Magento 2 (Beta)

It's still under development!

MageForge is a Magento 2 module designed to assist frontend developers in streamlining their workflow and enhancing productivity.

---

Magento Requirements

MageForge requires Magento 2.4.7 or higher. Please ensure that your Magento installation meets this requirement before installation.

Features

Supported Theme-Types 🎨

Theme Type	Support Status
🎯 Magento Standard	✅ Fully Supported
🚀 Hyvä	✅ Fully Supported
🔄 Hyvä Fallback	✅ Fully Supported
🎨 Custom TailwindCSS (no Hyvä)	✅ Fully Supported
💼 Avanta B2B	✅ Fully Supported
🥰 Your Custom Theme	Create your own Builder

---

Available Commands

Command	Description
mageforge:version	Shows current and latest version of the module
mageforge:system-check	Get system information (OS, PHP, Database, Node.js, etc.)
mageforge:theme:list	Lists all available themes
mageforge:theme:build	Builds selected themes (CSS/TailwindCSS)
mageforge:theme:watch	Starts watch mode for theme development

---

Getting Started

Installation

1. Add the repository to your composer.json:

   {
       "repositories": [
           {
               "type": "vcs",
               "url": "https://github.com/OpenForgeProject/mageforge"
           }
       ]
   }

2. Install the module via Composer:

   composer require openforgeproject/mageforge

3. Enable the module:

   bin/magento module:enable OpenForgeProject_MageForge
   bin/magento setup:upgrade

Getting Started

Theme Development

1. List all available themes:

   bin/magento mageforge:theme:list

2. Build a specific theme:

   bin/magento mageforge:theme:build <theme-code>

   Example: bin/magento mageforge:theme:build Magento/luma

3. Start watch mode for development:

   bin/magento mageforge:theme:watch <theme-code>

Supported Theme Types

• Magento Standard Themes: LESS-based themes
• Hyvä Themes: Tailwind CSS based themes
• Custom Tailwind Themes: Standalone Tailwind implementations

Tips & Tricks

• Use the -v option for more detailed output
• Watch mode supports hot-reloading for LESS and Tailwind
• Check system information anytime with mageforge:system-check

Extending MageForge

MageForge provides a modular architecture that allows developers to create custom theme builders for specific project requirements. For more information, see:

• Custom Theme Builders Documentation
• Commands Documentation

Report Feature or Bugs

MageForge provides several forms to submit feature requests or report a bug. You will find it in the issue section of GitHub.

Contributing

We welcome contributions from the community! Please see our Contributing Guidelines for more information on how to get involved.

License

See the LICENSE file for more details.

Support

For support, please open an issue on the GitHub repository or join our Discord community.

Changelog

All notable changes to this project will be documented in the CHANGELOG file.

---

Thank you for using MageForge! We hope it makes your development process smoother and more efficient.