Ankit

LeaderBoard

📗 Table of Contents

📗 Table of Contents
📖 [LeaderBoard]

📖 [LeaderBoard]

[LeaderBoard] is a Html , Css & javascript based project

🛠 Built With

1- HTML. 2- CSS. 3- Javascript.

Tech Stack

Client

Key Features

Webpack used

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

Web browser
Code editor.
git-smc.

Setup

Clone this repository to your desired folder:

Run this command:

  cd my-project
  git clone git@github.com:ankitt26/LeaderBoard.git

Install

Install this project with:

Example command:

  cd my-project
  npm install

--->

Usage

To run the project, execute the following command:

cd my-project
npm run start

API Key Generation

To make requests to the API use this link 🔗

`https://us-central1-js-capstone-backend.cloudfunctions.net/api/games`

Follow the steps below to generate the key:

Endpoints

This project includes the following endpoints:

`/games/`

Allowed actions:

POST: Create a new game

Mandatory parameters for POST action:

name: Name of the game

Parameters example for POST action (sent in the body of the request in JSON format):

{
  "name": "Example Game"
}

Return value: unique identifier for the game:

{
	"result": "Game with ID: Zl4d7IVkemOTTVg2fUdz added."
}

/games/:id/scores/

URL parameters:

id: unique identifier of the game

URL example: /games/Zl4d7IVkemOTTVg2fUdz/scores/

Allowed actions:

POST to create a new score for the given game
GET to get a list of scores for the given game

Mandatory parameters for POST action:

user: name of the user
score: points (number)

Parameters example for POST action (sent in the body of the request in JSON format):

{ 
	"user": "John Doe",
	"score": 42
}

Return value for POST action:

{
	"result": "Leaderboard score created correctly."
}

Parameters for GET action: none

Return value for GET action:

{
    "result": [
        {
            "user": "John Doe",
            "score": 42
        },
        {
            "user": "Peter Parker",
            "score": 35
        },
        {
            "user": "Wonder Woman",
            "score": 50
        }
    ]
}