mysther/leaderboard-t3m

Leaderboard créé à l'occasion du T3M, gérer par l'équipe du BDE ENSIBS Vannetais

Leaderboard-T3M

Table of contents

• About
• Installation
• Usage
  • Start
  • Add points
  • Add team
  • Edit team
  • Remove team
  • Add/edit maison
• Docker
• Preview
• Contributing
• Licenses

About

Leaderboard created for the T3M, managed by the ENSIBS Vannetais BDE team.

Installation

Use the package manager Node.js to install json-server.

git clone https://github.com/mysther78/leaderboard-t3m.git
cd leaderboard-t3m
npm install json-server --save-dev
echo your_secret_token > token

Usage

Start

node server.js

Go to http://localhost:3000/

Add points

Go to http://localhost:3000/admin.html

Add team

POST https://leader.entropy.land/equipes/6 
--header "Content-Type: application/json"
--header "Authorization: Api Token {token}" 
--data {
      "name": "Team name",
      "maison": "rah",
      "description": "Équipe",
      "point": 0,
			"id": 21
    }

Edit team

PATCH https://localhost:3000/equipes/{id}
--header "Content-Type: application/json"
--header "Authorization: Api Token {token}" 
--data {
      "name": "Team name",
      "maison": "rah",
      "description": "Équipe",
      "point": 0
    }

Remove team

DELETE https://localhost:3000/equipes/{id}
--header "Content-Type: application/json"
--header "Authorization: Api Token {token}"

Add and edit maison

Add new image as {maison_name}.png in public/src/

Docker

docker build -t leaderboard-t3m .

Preview

Contributing

Pull requests are welcome.

Licenses

MIT