{"id":241,"date":"2023-01-19T17:56:12","date_gmt":"2023-01-19T14:56:12","guid":{"rendered":"https:\/\/akaunting.com\/hc\/?post_type=docs&p=241"},"modified":"2023-01-21T20:08:53","modified_gmt":"2023-01-21T17:08:53","slug":"modules","status":"publish","type":"docs","link":"https:\/\/akaunting.com\/hc\/docs\/developers\/modules\/","title":{"rendered":"Modules"},"content":{"rendered":"\n

Akaunting ships with core accounting tools needed to manage money. It also has a modular structure so that you could extend it. We use the akaunting\/laravel-module<\/a> package as the builder.<\/p>\n\n\n\n

A module is like a Laravel package, it has some routes, views, controllers, and models. While technically we call it Module<\/code>, we name it App<\/code> in the UI for the end-user as that\u2019s what they are familiar with.<\/p>\n\n\n\n

Folder Structure<\/h3>\n\n\n\n

As you can see from the example below, the structure of a module is very similar to a basic Laravel app.<\/p>\n\n\n\n

app\/\nbootstrap\/\nconfig\/\ndatabase\/\nmodules\/\n  \u251c\u2500\u2500 MyBlog\/\n      \u251c\u2500\u2500 Console\/\n      \u251c\u2500\u2500 Database\/\n          \u251c\u2500\u2500 Migrations\/\n          \u251c\u2500\u2500 Seeds\/\n      \u251c\u2500\u2500 Http\/\n          \u251c\u2500\u2500 Controllers\/\n          \u251c\u2500\u2500 Requests\/\n      \u251c\u2500\u2500 Jobs\/\n      \u251c\u2500\u2500 Listeners\/\n      \u251c\u2500\u2500 Models\/\n      \u251c\u2500\u2500 Providers\/\n          \u251c\u2500\u2500 Event.php\n          \u251c\u2500\u2500 Main.php\n      \u251c\u2500\u2500 Resources\/\n          \u251c\u2500\u2500 assets\/\n          \u251c\u2500\u2500 lang\/\n          \u251c\u2500\u2500 views\/\n      \u251c\u2500\u2500 Routes\/\n          \u251c\u2500\u2500 admin.php\n          \u251c\u2500\u2500 portal.php\n      \u251c\u2500\u2500 composer.json\n      \u251c\u2500\u2500 module.json\n      \u251c\u2500\u2500 package.json\n      \u251c\u2500\u2500 webpack.mix.js\npublic\/\n...\nvendor\/\n.env<\/code><\/pre>\n\n\n\n
Creating a module<\/h3>\n\n\n\n
There are loads of Artisan commands built-in the module package. For example, let\u2019s see how to make a new module:<\/p>\n\n\n\n
php artisan module:make my-blog<\/code><\/pre>\n\n\n\n
This will create all files and folders shown in the above example.<\/p>\n\n\n\n
Installing the module<\/h3>\n\n\n\n
Now let\u2019s install the module using the following command:<\/p>\n\n\n\n
php artisan module:install my-blog 1<\/code><\/pre>\n\n\n\n
my-blog<\/code>\u00a0is the\u00a0alias<\/strong>\u00a0of the module and\u00a01<\/code>\u00a0is the\u00a0company id<\/strong>\u00a0that you want to install the module.\u00a0Here<\/a>\u00a0you can find more about companies in Akaunting.<\/p>\n\n\n\n
Alias is the unique name of the module as is used everywhere in Akaunting.<\/p>\n\n\n\n
module.json file<\/h3>\n\n\n\n
The module.json<\/code> file contains the main information about your module such as name, version, providers, etc..<\/p>\n\n\n\n
{\n    \"alias\": \"my-blog\",\n    \"icon\": \"edit\",\n    \"version\": \"1.0.0\",\n    \"active\": 1,\n    \"providers\": [\n        \"Modules\\\\MyBlog\\\\Providers\\\\Main\"\n    ],\n    \"aliases\": {},\n    \"files\": [],\n    \"requires\": [],\n    \"reports\": [],\n    \"widgets\": [],\n    \"settings\": []\n}<\/code><\/pre>\n\n\n\n
You can check the Offline Payments<\/strong> module built into the Akaunting core as a live example.<\/p>\n\n\n\n
Showing to the user<\/h3>\n\n\n\n
If your module has pages that need to be shown in the left sidebar, you can check this<\/a> article to learn more.<\/p>\n\n\n\n
More<\/h3>\n\n\n\n
Module<\/a> documentation can help to understand how the system works.<\/p>\n","protected":false},"excerpt":{"rendered":"
Akaunting ships with core accounting tools needed to manage money. It also has a modular structure so that you could extend it. We use the akaunting\/laravel-module package as the builder. A module is like a Laravel package, it has some routes, views, controllers, and models. While technically we call it Module, we name it App in the UI for the […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":31,"menu_order":3,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-241","docs","type-docs","status-publish","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs\/241","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/comments?post=241"}],"version-history":[{"count":7,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs\/241\/revisions"}],"predecessor-version":[{"id":274,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs\/241\/revisions\/274"}],"up":[{"embeddable":true,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs\/31"}],"wp:attachment":[{"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/media?parent=241"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/doc_tag?post=241"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}