Leaderboard API Application"

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [LEADERBOARD APP']

[Leader Board App] The Leaderboard API Application is a powerful and versatile JavaScript application that utilizes REST methods to provide users with the ability to create games, submit scores, and retrieve scores for a selected game. The codebase is structured into various modules, each responsible for specific functionalities within the game. By incorporating cutting-edge technologies such as ES6 modules, Webpack, and the Leaderboard API's RESTful interface, this application offers a comprehensive solution for effectively tracking, displaying, and analyzing scores in an intuitive and efficient manner.

🛠 Built With

This project was built using: HTML, CSS and JAVASCRIPT, WEBPACK

Tech Stack

HTML

CSS

Javascript

Webpack

Git

Github

Netlify

Client

• HTML

Styles

• CSS

Language

• CSS

Database

• GIT

Key Features

• [HTML & CSS Best practices]
• [Add New Game]
• [Add User and Score]
• [Display Users and Scores ]
• [Update Task ]
• [Seamless Integration ]
• [ES6 Modules ]
• [Webpack Bundling ]
• [CI and CD Deployment with Netlify]

Create Game:

Users can create new games by specifying a game name. The application utilizes the HTTP POST method to send a request to the Leaderboard API, which generates a unique game ID and stores the game name and ID in the database.

Submit User Score:

Users can submit their scores for a selected game by providing their name and score. The application employs the HTTP POST method to send the score data to the Leaderboard API, associating it with the corresponding game ID in the database.

Retrieve Scores:

Users can retrieve scores for a selected game using the HTTP GET method. The application sends a request to the Leaderboard API, which responds with an array of scores sorted in descending order. These scores are then displayed in the user interface.

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

To run this project you need the following tools:

• [VS Code ]
• [Git and GitHub ]
• [Webpack Installation ]
• [CI CD Netlify Bot Instalation]
• [Nodejs ]

Setup

Clone this repository to your desired folder:

 cd leaderboard
 git clone git@github.com:alyconr/leaderboard.git

Install

Install this project with:

Lighthouse run

    npm install -g @lhci/cli@0.7.x

Webhint:

     npm install --save-dev hint@7.x

Stylelint:

     npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x

Eslint

     npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x

Webpack

     npm init -y
     npm install webpack webpack-cli --save-dev

Webpack Css loader

     npm install --save-dev style-loader css-loader

Webpack html plugin

     npm install --save-dev html-webpack-plugin

Webpack dev server

     npm install --save-dev webpack-dev-server

Usage

To run locally run the following command:

    npm run build
    npm run start

Run tests

To run tests, run the following command:

To test the Stylelint linter:

    npx stylelint "**/*.{css,scss}"

To test the Webhint:

    npx hint .

To test the ESLint linter:

    npx eslint .

Deployment

You can deploy this project using your local enviroment or use Netlify bot to deploy it online.

(back to top)

👥 Authors

JEYSSON CONTRERAS

👤 Author1

• GitHub: @alyconr
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [User Authentication]
• [Sorting and Filtering]
• [Score Analytics]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project please give one start.

(back to top)

🙏 Acknowledgments

I would like to thank God for giving me the strength to carry out this project.

(back to top)

(back to top)

📝 License

This project is MIT licensed.

(back to top)