README

MageForge is a powerful CLI front-end development toolkit for Magento 2 that simplifies theme development workflows. It provides tools for many types of Magento themes and can be easily extended for your custom theme. With MageForge, themes can be built lightning fast, without your developers having to worry about the details. MageForge eliminates complex configuration requirements and significantly reduces setup time, allowing Magento developers to focus on creative aspects instead of struggling with build processes.

Supported Magento Versions

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	Shortcodes
`mageforge:system:version`	Shows current and latest version of the module	`m:s:v`
`mageforge:system:check`	Get system information (OS, PHP, Database, Node.js, etc.)	`m:s:c`
`mageforge:theme:list`	Lists all available themes	`m:t:l`
`mageforge:theme:build`	Builds selected themes (CSS/TailwindCSS)	`m:t:b`, `frontend:build`
`mageforge:theme:watch`	Starts watch mode for theme development	`m:t:w`, `frontend:watch`

Getting Started

Installation

Install the module via Composer:

composer require openforgeproject/mageforge

Enable the module:

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

Quick Start Guide

List available themes:
```
bin/magento mageforge:theme:list
```
Build a theme:
```
bin/magento mageforge:theme:build <theme-code>
```
Example: bin/magento mageforge:theme:build Magento/luma

Start development watch mode:

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

Enjoy automatic CSS rebuilding you work on your theme files!

Additional Documentation

Advanced Usage Guide - Tips, tricks and troubleshooting
Custom Theme Builders Documentation - Extend MageForge for your custom themes
Commands Documentation - Detailed command reference

Community & Support

Report Bugs/Features: GitHub Issues
Get Help: Discord Community
Contributing: See Contributing Guidelines

Project Information

License: LICENSE
Changelog: CHANGELOG

Thank you for using MageForge!

openforgeproject/mageforge

包简介

README 文档