Leaderboard

📗 Table of Contents

• 📗 Table of Contents
• 📖 [Leaderboard]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Project Structure
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 [Leaderboard]

This project consists of building a leaderboard website that displays scores submitted by different players. The website also allows users to submit their own scores. All data is preserved through the use of an external Leaderboard API service.s.

🛠 Built With

Tech Stack

HTML JS (Javascript) CSS WEBPACK

Client

• HTML

Server

Key Features

• [Webpack Configuration]
• [HTML Generation]
• [CSS Styling]
• [Development Server]
• [Code Quality]
• [Modular Structure]
• [ES6 Syntax]
• [JavaScript Functionality]
• [Gitflow]
• [Send and receive data from API]

(back to top)

🚀 Live Demo

You can see a Demo here: Demo

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps. This project requires Node.js and npm installed on your machine.

-Node.js -npm

-Clone this repository to your local machine using:

git clone https://github.com/ClaudiaRojasSoto/Leaderboard.git

-Navigate to the project folder:

cd Leaderboard

-Install the project dependencies:

npm install

o start the development server, run the following command:

npm start

Project Structure

The project follows the following folder and file structure:

/src: Contains the source files of the application. /src/index.js: Main entry point of the JavaScript application. /src/style.css: CSS file for the application styles. /src/index.html: Base HTML file of the application. /dist: Contains the generated production files. webpack.config.js: Webpack configuration file.

Setup

Clone this repository to your desired folder: https://github.com/ClaudiaRojasSoto/Leaderboard.git

Install

Install this project with: install WebLint and ESLint

Usage

To run the project, execute the following command: just need a web Browser

Run tests

To run tests, run the following command: you just need a simple web browser to run this project for a test

👥 Authors

👤 Claudia Rojas

• GitHub: @githubhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [User Authentication]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project show support by following this account

(back to top)

🙏 Acknowledgments

• Microverse for providing the opportunity to learn Git and GitHub in a collaborative environment.

• GitHub Docs for providing a wealth of information on Git and GitHub.

(back to top)

📝 License

This project is MIT licensed.

(back to top)