Git Product home page Git Product logo

open-web-leaderboard's Introduction

Open Web Leaderboard

The Open Web Leaderboard is a leaderboard that can easily be used with any backend as long as you find a way to supply the following information (see database.py):

  • getRankRange(start, end) -> return a list of players from start rank to end rank
  • getMaxEntries() -> return the total number of entries in the leaderboard
  • findPlayer() -> find a player by name and return a (player, rank)-tupel

The system was developed to be used with the skillbird-framwork. If you use this framework, the program should be working without any arguments. If you need more conductibility feel free to open a pull-request or send me a message.

Requirements

  • MDB Jquery (unpack to ./static/bootstrap/)
  • Fontawesome (move to static/boostrap/fontawesome.css)
  • python3 -m pip install -r req.txt
  • Moment.js (directly into static/)

How to run

You can run the leaderboard as a flask standalone (arguments overwrite config.py settings!):

./server.py --skillbird-db PATH_TO_DB

or with a runner like waitress:

/usr/bin/waitress-serve --host 127.0.0.1 --port 5002 --call 'app:createApp'

the DB_PATH is set in config.py in this case.

GDPR: Blacklisting players

Players can be blacklisted by name via a blacklist.json file in the project root.

{
    "blacklist" : ["name", "name_2"]
}

Adding servers for player count live info

Source-Servers can be added via the servers.json-file:

[
    {
        "name" : "server_1",
        "host" : "example.com",
        "port" : 27015
    },
    {
        ...
    }
]

Python-valve is required if this file exists.

Live Demo

insurgency.atlantishq.de

open-web-leaderboard's People

Contributors

fausheppy avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

open-web-leaderboard's Issues

i need help

can you teach me how can i run it on my ubuntu 18.04 vds server? thanks :)

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.