# GigaTools by WebKinder
Useful Links:
 - [Documentation](https://www.gitbook.com/book/orlandster98/gigatools)
 - [Pro version](https://www.gitbook.com/book/orlandster98/gigatools)
 - [Author](https://www.webkinder.ch)


##Installation
So first of all you need to clone the repository. To do that move into the folder you would like to have the plugin.

Done? Just hit this command in your CLI (terminal).
```
git clone https://github.com/webkinder/gigatools.git
```


A little joke to kill the waiting time:

>**How to check if a website uses HTML5?**
>- Open it in Internet Explorer
>- Did it work?
>- No? It's HTML5.

Now activate the plugin in your WordPress backend and the show can go on.

##Documents
In this Chapter you'll learn everything about the file structure beginning with the `README.md` folder.

`README.md` - The file you're currently reading. Yes, it's hard to believe, but it's really the file you're reading right now. All this "blablablass" are located in this file.
> **Note:** Update this file whenever changing something on the file structure. Not writing documentation could destroy your computer.

`wk-giga.php` - Hold's a lot of includes and executes all the other classes

###assets
Here we are. In this folder you'll find all the non source code items. Which means no backend technologie (php files). Of course scripts and styles are situated in this folder.

####css
`lib` - Includes all the libraries (Font Awesome so far)

`admin-styles.css` - Includes all the styles used in the backend to improve the Admin UI

`filter.css` - Includes all the logic to filter events

`grid.css` - Includes all the styles for the grid view

`list.css` - Includes all the styles for the list view

####img
All the images are located here.

####js
`admin-functions.js` - Includes all the code to improve the backend.

`events.js` - Includes all code to create the events from GigaTools API

`jquery.filterizr.js` - Script to handle the event filter logic

###custom
That's just an empty folder or isn't it? Open it to find out. As you now know that the folder is empty you can insert custom templates, styles and scripts into it.
Find more about templating [here](https://orlandster98.gitbooks.io/gigatools-1-0-0/content/gigatools_for_developers.html).

###includes
This is the place where all the features should be located. If you write a feature into my start class I will personally wring your neck! Ok, I'm just kidding, but please don't do it anyway.

`metaBoxSettings.php` - settings to generate a new meta box (generic way)

`postType.php` - Generic posttype generator (you've heard right the class can generate different post types)

`postTypeGigatools.php` - Metadata for Posttype Gigatools (will be generated by `postType.php`)


####shortcode
`templates` - All the views live here. **Note:** not the custom template

`backendApi.php` - Returns all the settings

`dataHandler.php` - Returns all the Data from the GigaTools Api

`shortcode.php` - Everything in relation to the view comes together here

`templateLoader.php` - loads different templates based on the settings choosen by user

###lang
Includes all the translations needed. Which means it's empty learn english! //todo: find a better excuse for my idleness