📗 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
• 📝 License

📖 [Leaderboard Project] A JavaScript project for a simple Leaderboard list app. It allows a user to add score and name, and display it on board-like form

Learning objectives for this project was to create a leaderboard, and with an api that stores, score inputs

[Leaderboard Project] is a live scoreboard/Leaderboard api

🛠 Built With

• HTML
• CSS
• Javascript (ES6)

Tech Stack

The tech stack, used in this project is as follows:

• HTML
• CSS
• JavaScript
• API's
• Webpack

Key Features

1-3 key features of the application.

• [load/display scores from the api]
• [add scores to the api]
• [button functionality and input field required]

🚀 Live Demo

• Live Demo Link

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Have a local version control like Git. Which is a open source distributed version control system designed for source code management
• A text editor (e.g Visual Studio Code, Vim, Atom & Sublime.)
• A web browser (e.g Chrome, Safari, Mozilla Firefox.)
• Live Server which is a web extension that helps you to live reload feature for dynamic content (PHP, Node.js, ASPNET)
• Download waves to check project accessibilty

Setup

Clone this repository to your desired folder:

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

• npm

  npm install npm@latest -g
  

Install

Install this project with:

1. Clone the repo by running the command

    git clone https://github.com/PeteUgwu/Leaderboard-app
   

2. Open the directory of the project

   cd set-up
   

3. Open the directory of the src

   cd src
   

4. Open the html file

   Click and open the html file
   

5. Please install the node module by running this command on the terminal

   npm install
   

6. Please run the following to render on the browser

   npm start
   

Usage

To run the project, execute the following command:

1. Please run the following to render on the browser

   npm start
   

👤 Peter

• GitHub: @PeteUgwu
• Twitter: @Petrus4Charles
• LinkedIn: /peteugwu/

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• [css to complete styling]

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

Please give this project repo a star⭐️

If you like this project...

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank...

❓ FAQ

Add at least 2 questions new developers would ask when they decide to use your project.

• [Question_1]

  • [what are the prerequisites]

• [Question_2]

  • [how do i go about installing it]

📝 License

This project is MIT licensed.