integer-net / magento2-module-template

Template repository for open source Magento modules on Github

integer_net Magento 2 Module Template

This is a GitHub template.

Create your module now with the "use this template" button:

After that, clone it on your machine and run ./dev/init inside the repository directory for automatic configuration. For more information, see dev/README.md

---

:module-namespace_:module-name Magento Module

---

:description

Installation

1. Install it into your Magento 2 project with composer:

   composer require :vendor/:package
   

2. Enable module

   bin/magento setup:upgrade
   

Configuration

Usage

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Testing

Unit Tests

./vendor/bin/phpunit tests/unit

Magento Integration Tests

0. Configure test database in dev/tests/integration/etc/install-config-mysql.php. Read more in the Magento docs.

1. Copy tests/integration/phpunit.xml.dist from the package to dev/tests/integration/phpunit.xml in your Magento installation.

2. In that directory, run

   ../../../vendor/bin/phpunit

Security

If you discover any security related issues, please email :author-email instead of using the issue tracker.

Credits

• :author-name
• All Contributors

License

The MIT License (MIT). Please see License File for more information.