weyne/wifipineapple-wiki
1
0
Fork 0
mirror of https://github.com/hak5darren/wifipineapple-wiki.git synced 2025-10-29 16:59:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add information about structure

Browse Source
This commit is contained in:
Marc 2016-04-06 00:00:40 +01:00
parent 342e9fb668
commit 7a16bab7eb
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
creating_modules.md
View File

@ -9,8 +9,20 @@ Modules use HTML, AngularJS and PHP to make requests and retrieve a response. Th
##Anatomy of a basic module ##Anatomy of a basic module
A basic module will request information through AngularJS to PHP, and then the PHP will provide a response to AngularJS, where it will then be displayed on the HTML page for the user to see. A basic module will request information through AngularJS to PHP, and then the PHP will provide a response to AngularJS, where it will then be displayed on the HTML page for the user to see.
``` ```
+-------------------+ +--------------+ +-----------+ +------+ +-------------------+ +--------------+ +-----------+ +------+
| AngularJS Request | --> | PHP Response | --> | AngularJS | --> | HTML | | AngularJS Request | --> | PHP Response | --> | AngularJS | --> | HTML |
+-------------------+ +--------------+ +-----------+ +------+ +-------------------+ +--------------+ +-----------+ +------+
``` ```
A module will contain at least four files required to function. A `module.html` that contains the HTML for the module, A `module.info` that contains the name, description, version and author of the module in JSON format, a `module.js` file inside of the `js/` folder that contains the AngularJS, and finally a `module.php` file inside of the `php/` folder. It is structured like this:
```
.
├── js
│   └── module.js
├── module.html
├── module.info
└── php
└── module.php
```