The goal is simple: to give Magento users an easy way to find modules that can enhance their e-commerce platforms. Beyond just listing these modules, we also run basic tests to check if they can be installed without issues.
The heart of this repository is a JSON file that acts as a data source for the PackageMaven website. This website showcases a catalog of Magento modules, making it easy for users to discover tools that can help expand the functionality of their Magento stores.
Each module is represented by a key-value pair, where the key is the module's Packagist name and the value is an object with the following properties:
{
"vendor/module-name": {
"name": "Friendly Name of the Module",
"description": "A short explanation of what the module does.",
"packagist_source": "vendor/module-name"
}
}
This format helps our website share details about each module, like what it does and where to find it.
If you’ve got a Magento module that you think the world should know about, here’s how to get it listed:
- Fork this project: This means making your own copy to work on.
- Add your module to the list: Follow the format above. Be sure to include:
- The full name of your module.
- A simple, descriptive name and a brief explanation.
- The
"packagist_source"
should be exactly how it appears on Packagist, which is a website where people can find and download PHP packages.
- Send a pull request: This is like knocking on our door with your changes ready to go.
Our initial set of modules was inspired by the open-source resources shared by MageRes, a fantastic community hub for Magento developers.