/JumpRanking

Jump Ranking - REST Service + Web

Primary LanguagePythonGNU Lesser General Public License v3.0LGPL-3.0

Jump Ranking

Codacy Badge License

Simple Jump Ranking created using a REST service developed in Python and Web viewer developed in HTML and Javascript.

What can I do with Jump Ranking?

  • Run decoupled project with REST service and Web viewer
    • Run service in a server or cloud
    • Run Web viewer from repository or host the web in Apache server
  • Use it as base project for bigger projects

๐Ÿ› ๏ธ Installation


๐Ÿค– REST Service

Install service requirements using requirements.txt:

pip install -r requirements.txt

Run with and follow linkero instructions:

python jumprankingAPI_main.py

โš ๏ธ REST service runs with Python2 and Python3

๐Ÿ‘€ Web Viewer

Host Web viewer directly from GitHub with raw.githack.com:

https://raw.githack.com/RDCH106/JumpRanking/master/web/jumpranking-viewer.html

Use http_server_with_cors.py server included in the project behing a reverse proxy with SSl certificate. The server include CORS support.

Host in a traditional Apache server, Nginx... or that you want.


REST Service ๐Ÿ”Œ API


Resgiters list access:

Verb (GET) - ๐Ÿ”“ No-Auth - Response (JSON)

https://your_host:port/jumpranking/api/v1/registers

๐Ÿ’ก You can open it from the browser by entering the URL



Add register:

Verb (POST) - ๐Ÿ”Auth - Response (JSON + HTTP 201 --> added)

https://your_host:port/jumpranking/api/v1/registers/<username>/<height>

๐Ÿ’ก Replace <username> and <height> by desired values

โš ๏ธ Requiered HTTP Basic Auth using User:Password or using Token



Delete registers list:

Verb (DELETE) - ๐Ÿ”Auth - Response (JSON + HTTP 204 --> deleted)

https://your_host:port/jumpranking/api/v1/registers

โš ๏ธ Requiered HTTP Basic Auth using User:Password or using Token