Skip to content

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

License

Notifications You must be signed in to change notification settings

OpenForgeProject/mageforge

Repository files navigation

MageForge for Magento 2

Mageforge Hero

Release License CodeFactor Magento Compatibility Test

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 🎨

Mageforge Hero

Theme Type Support Status
🎯 Magento Standard ✅ Fully Supported
🚀 Hyvä (TailwindCSS 3.x / 4.x) ✅ 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 Aliases
mageforge:theme:list Lists all available themes frontend:list
mageforge:theme:build Builds selected themes (CSS/TailwindCSS) frontend:build
mageforge:theme:watch Starts watch mode for theme development frontend:watch
mageforge:theme:clean Clean theme static files and cache directories frontend:clean
mageforge:hyva:compatibility:check Check modules for Hyvä theme compatibility issues hyva:check
mageforge:hyva:tokens Generate Hyvä design tokens (Hyvä themes only) hyva:tokens
mageforge:system:version Shows current and latest version of the module system:version
mageforge:system:check Get system information (OS, PHP, Database, Node.js, etc.) system:check

Getting Started

Installation

  1. Install the module via Composer:

    composer require openforgeproject/mageforge
  2. Enable the module:

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

Quick Start Guide

  1. List available themes:

    bin/magento mageforge:theme:list
  2. Build a theme:

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

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

  3. Start development watch mode:

    bin/magento mageforge:theme:watch <theme-code>
  4. Generate Hyvä design tokens (for Hyvä themes):

    bin/magento mageforge:hyva:tokens <theme-code>

    This creates a generated/hyva-tokens.css file from your design tokens configuration.

  5. Enjoy automatic CSS rebuilding as you work on your theme files!

Additional Documentation

Support

Project Information


Thank you for using MageForge!