Skip to content

Latest commit

 

History

History
90 lines (54 loc) · 4.08 KB

README.md

File metadata and controls

90 lines (54 loc) · 4.08 KB
Raw

gamify - A gamification platform to implement any serious game mechanic

Testing with MySQL codecov License Laravel Version GitHub release

Presentation

Game of Work, aka GoW!, was a gamification platform created by Emilio Ampudia (eampudia at gmail.com) and Paco Orozco (paco at pacoorozco.info).

We wanted to teach, learn and share some fun with our colleagues, so we created a game based on questions about our organization (process, services, teams...). This was the birth of gamify, a platform implementing a levels & badge game at UPCnet.

After that I've been developing it as a pet project. Nowadays, it's a Laravel application, based on the deprecated PHP5 original version.

As much as possible, I've tried to keep a clean code to work everywhere out of the box. You are not obliged to use my tools and you are free to change the code in order to use it at your own feeling.

Disclaimer - It's ready for production, but no doc

It's fully working and you can play with it, but it lacks of some documentation. I'm working in order to improve it, in my personal free time, so be patient or contact me in order to give me your help.

Changelog

See CHANGELOG file in order to know what changes are implemented in every version.

How to run gamify

This will create several Docker containers to implement all gamify needs. An application server, a web server and a database server.

Prior this installation, you need to have installed this software:

  1. Clone the repository locally

    $ git clone https://github.com/pacoorozco/gamify-laravel.git gamify
$ cd gamify

  2. Copy .env.example to .env.

    NOTE: You don't need to touch anything from this file. It works with default settings.

  3. Start all containers with Docker Compose

    NOTE: You must export the DOCKER_APP_UID variable if your user ID is different from 1000. This will allow the docker to get permissions over your files.

    $ export DOCKER_APP_UID="$(id -u)"
$ docker-compose build
$ docker-compose up -d

  4. Install dependencies with:

    $ docker-compose exec app composer install

  5. Seed database in order to play with some data

    $ docker-compose exec app php artisan key:generate 
$ docker-compose exec app php artisan migrate:fresh --seed

  6. Go to http://localhost. Enjoy!

    NOTE: Default credentials are [email protected]/admin or [email protected]/player

Reporting issues

If you have issues with gamify, you can report them with the GitHub issues module.

Contributing

Please see CONTRIBUTE for details.

License

gamify is released as free software under GNU GPL v3.0 or later

Authors

gamify was originally developed by Emilio Ampudia and Paco Orozco as part of a game in UPCnet. Later, the original version was migrated to Laravel.

See contributor list for a complete list of contributors.