( Version 2.1 )

Distribution of Gamification Platform installed on Joomla 3.6.0. It should be used as development environment where everyone can contribute a code to the project.

##Documentation You can find documentation on following pages.

Documentation and FAQ

API documentation

##Download You can download Gamification Platform package from the website of ITPrism.

##License Gamification Platform is under GPLv3 license.

##How to install the distribution and contribute a code? If you would like to add new feature to the extension or you would like to fix an issue, you should send pull request. How to do it?

• Fork this repository. That will create a copy in your GitHub account.
• Clone the repository, that you have just forked, on your PC .
• Install the distribution like Joomla! on your localhost. Note: You should not remove the folder 'installation' on the last step of the installation process.
• The installer will remove some files (joomla.xml, robots.txt.dist). You have to revert the files.
• Create branch and write your code.
• When you are done, push your branch to your remote (forked) repository.
• Go to your repository and create pull request.

##Branches There are two general branches - master and develop. The master branch contains the stable code. The "develop" is a branch where we will merge all pull requests. You should use the "develop" branch as development environment on your localhost. There will be "release" branches where we will prepare newest releases for publishing.

If you would like to create a package that you will be able to install on your Joomla site, you should follow next steps.

• You should install ANT on your PC.
• Download or clone the code from this repository.
• Download or clone [Gamification Platform package] (https://github.com/ITPrism/GamificationPlatform).
• Rename the file build/example.txt to build/antconfig.txt.
• Edit the file build/antconfig.txt. Enter name and version of your package. Enter the folder where the source code is (Gamification Platform distribution). Enter the folder where the source code of the package will be stored (the folder where you have saved this repository).
• Save the file build/antconfig.txt.
• Open a console and go in folder build.
• Type ant and click enter. The system will copy all files from distribution to the folder where you are going to build the installable package.