CLI code-generation tool for Magento 2 developers with built in User Interface
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
resources
src
tests
ui-app
.env.example
.gitignore
.travis.yml
README.md
angular.json
bootstrap-api.php
bootstrap.php
commands.php
composer.json
hotrod
hotrod-ui
index.php
package.json
phpunit.xml.dist
routes.php

README.md

Scrutinizer Code Quality Build Status codecov Join the chat at https://gitter.im/hotrod-cli/Lobby

This package helps you generate Magento 2 code using a clean commandline tool. All classes, templates, layouts and etc. can be dynamically generated and put together.

Features

  • Generates different kind of magento 2 module components
  • has a build in UI
  • Easy to start using

Documentation

You'll find full documentation here.

Example

Lets review an example

vendor/bin/hotrod create:controller Dmiva_Test dmiva/testing/test

This line tries to create a controller for the route dmiva/testing/test in Dmiva_Test namespace. Magically it creates for You a module Dmiva_Test if it is not exists and generates files :

  • app/code/Dmiva/Test/registration.php
  • app/code/Dmiva/Test/etc/module.xml
  • app/code/Dmiva/Test/etc/frontend/routes.xml
  • app/code/Dmiva/Test/view/frontend/layout/dmiva_testing_test.xml
  • app/code/Dmiva/Test/Controller/Testing/Test.php
  • app/code/Dmiva/Test/Block/Testing.php
  • app/code/Dmiva/Test/view/frontend/templates/test.phtml

To open the User Interface, run this command

vendor/bin/hotrod-ui

It will build the Angular app and run the basic build in php server on http://localhost:8008/.

Installation

You can install the package via composer:

composer require --dev dmitrijivanenko/hotrod-cli

Contributing

Help is very welcomed. We accept contributions via Pull Requests on Github. Please read and understand the contribution guide before creating an issue or pull request.

Licence

This project is open-sourced software licensed under the MIT license.