Git Product home page Git Product logo

devleauge.gamification-server's Introduction

Gamification Server

Gamification-server provides a framework for providing awards/points to users or teams and can be operated either standalone or integrated with other web-based applications. Based on the notion of badges used within other gamification systems. The gamification-server is implemented as an Express.js web application. This gamification server was built by DevLeague.

APIs and remote usage

Gamification-server is designed so that other sites can send in "signals" that are parsed through a rules engine and generate points and badges. Also, other sites and apps can pull in JSON to list badges that a user has.

End Points

  • GET /api/player Returns an array of all the players

  • POST /api/player/new Creates a new player and returns the new player

  • GET /api/player/id/<PLAYER_ID> Returns the player's current stats, badges and achievements

  • GET /api/player/name/<PLAYER_NAME> Returns the player's current stats, badges and achievements

  • GET /api/player/<PLAYER_NAME>/badges Returns all the badges

  • POST /api/player/<PLAYER_NAME>/assign_badge Creates a new badge for the player and returns an array of all the players badges.

Installation

  • Make sure Node.js, NPM, MongoDB and Git are installed.

  • Download and unpack the project on your computer in the directory of your choice. Or alternatively checkout from source:

$ git clone [email protected]:devleague/gamification-server.git
$ cd gamification-server
  • Next, inside the project, you need to install the project's various NPM dependencies:
$ npm install
  • And you should now be ready to spin up a development build of your new project:
$ npm start

Contributing

If you'd like to contribute to this project, please make a pull request. We'll review the pull request and discuss the changes. All pull request contributions to this project will be released under the MIT license.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Credits

devleauge.gamification-server's People

Contributors

joekarlsson avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.