Custom Magento v2.4.6-p3 Blog Posts module to cover most of Magento 2 concepts and design patterns.
It covers the app structure, how routing & controllers work, how to extend core code, dependency injection & interfaces, different design patterns and usages, ways to modify the page layout, and understand data management.
The module is not intended to be used in production. It is a sample module to be used as a reference for Magento 2 development.
The module is based on the Magento 2.4.6-p3 version.
It provides the following functionality: Custom database table to store blog posts. Custom model to manage blog posts. Custom Web API endpoints to create, update, delete, and get blog posts. Custom service contracts to create, update, delete, and get blog posts. Custom Observer to log blog post creation. Custom frontend page to create a blog post. Custom frontend page to edit a blog post. Custom frontend page to delete a blog post. Custom frontend page to display blog posts.
- Plugin to add extra information to the blog post (just to show how to use plugins).
- Admin system configuration to enable/disable the module and other settings.
- Admin grid to display blog posts.
- Admin form to create/edit/delete blog posts.
- Admin ACL to manage blog posts.
- Admin menu to manage blog posts.
- Admin mass actions to delete blog posts.
- Admin UI component to manage blog posts.
To install use composer or copy files manually. It is recommended to install the module in a development environment first. The
Add the repository to composer.json
composer config repositories.rubenromao git https://github.com/rubenromao/m2-module-blog-posts.git
This will add the following to your composer.json's repositories section
"repositories": {
"rubenromao": {
"type": "git",
"url": "https://github.com/rubenromao/m2-module-blog-posts.git"
},
}
Install the module
composer require rubenromao/m2-module-blog-posts:1.0.0
Run the following command to enable the module:
bin/magento module:enable RubenRomao_BlogPosts
You must run the following commands after the module installation using magento-cli
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy -f (optional if you are in developer mode)
bin/magento cache:flush
For information about a module installation in Magento 2, see Enable or disable modules.
The RubenRomao_BlogPosts module contains extensibility points that you can interact with. Web API, Service contracts, plugins, events, and observers enable you to extend and customize the Magento application. You can interact with the following extension points:
Extension developers can interact with the RubenRomao_BlogPosts module. For more information about the Magento extension mechanism, see Magento plug-ins.
The Magento dependency injection mechanism enables you to override the functionality of the RubenRomao_BlogPosts module.
The module introduces layout handles in the view/frontend/layout directory.
You can extend these layouts in your custom modules and themes.
For more information about a layout in Magento 2, see the Layout documentation.
You can extend product and category updates using the UI components located in the view/adminhtml/ui_component directory.
Or you can extend the UI components located in the view/base/ui_component directory.
For information about a UI component in Magento 2, see Overview of UI components.
The RubenRomao_BlogPosts module creates a new database table rubenromao_blog_post during the installation process.
This table stores blog posts.
For information about significant changes in patch releases, see Release information.