README

Description

A starter project for beginning module development in Magento 2. Also a template for future Magento 2 projects.

Setting up the default files required by Magento 2 when building a custom module decreases development time and maintains consistency across projects.

Facts

• Version: 000.1.1
• Repository on Github

Getting Started

Instructions on how to download, install, and configure the module.

Requirements

• Git
• Composer

Known Issues

• Link to any Github issues, or list issues w/ Magento 2 compatibility or Extension compatibility

Related Projects / Tickets / Stories

If you use your module internally, try to add links to related documentation covered in projects or tickets.

• #00000 - Task Title goes here
• #00001 - Task Title goes here
• #00002 - Task Title goes here
• #00003 - Task Title goes here
• #00004 - Task Title goes here
• #00005 - Task Title goes here

Installation

Includes a series of step-by-step examples for installation and configuration.

$ composer require iods/module-bones
$ bin/magento module:enable Iods_Bones
$ bin/magento setup:upgrade
$ bin/magento cache:flush 

Deployment

Add additional notes about how to deploy this on a live system

Built With

• Your Framework - The web framework used
• Your Dependency Management - Dependency Management
• Other Tools, you use - Any Kind of Generator for example

Magento 2

Components

Explain how you made you module. Did you make use of Plugins or Observers? Where is the entry point of the module.

Extensions

Explain how to extend your module.

Give an example

Configurations

Give an overview of the given configurations.

Development

Structure

How does it work? What components in the module exist. What is different. Link to devdocs.

Finishing w/ an example of system information of demo of the module for your team.

Extensibility

Includes a series of step-by-step examples for extending the module and code snippets of the extension points.

Events

A list of events dispatched by the module.

Layouts

Does it introduce layouts or layout handles?

UI Components

Does the module introduce any UI components or the configuration files, where are they?

Public API

Does the module introduce any public API? what services are introduced?

\Magento\Sales\Api\InvoiceOrderInterface
  * Create an Invoice
  * Change status and state

Packagist Setting

• Create account
• Connect with Github account
• Submit package
  • URL example: https://github.com/rangerz/magento2-module-template

Tests

Includes a series of step-by-step examples for testing the module.

Code Styles

Includes any relevant code style information or documentation.

Configuration

Overview of the admin/configuration settings within the module.

Support

If you have any issues with this project, open an issue on Github

Developer

• Rye Miller - Initial work - GitHub, Homepage

See also the list of contributors who participated in this project.

Versioning

For transparency into the release cycle and in striving to maintain backward compatibility, this project is maintained under the Semantic Versioning guidelines.

License

This project/code is released under the MIT license.

Copyright

(c) 2022 Rye Miller. All Rights Reserved.