README.md

Leaderboard

📗 Table of Contents

• 📖 About the Project
• • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Author
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Leaderboard

Leaderboard is a project that was created to inline with the Microverse curriculumn. It is a app that makes calls to an api and displays recent scores posted on the API. In addition, it also allows the user to post some information to the API.

🛠 Built With

Tech Stack

Client

• HTML and CSS
• JavaScript and Webpack

Key Features

I plan to implement the following features:

• [List] This section showcases the list of recent scores posted to an API.
• [Form] This section provides two inputs that the user can use to feed a name and a score to the API.
• [Buttons] Buttons on the app allow the user to manipulate the list by either refreshing the list, or submitting a new entry.

(back to top)

💻 Getting Started

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

Prerequisites </>

In order to set up a local copy of this repository, you need to have git installed:

Install Git

Setup

Clone this repository to your desired folder:

Example commands:

  mkdir my-folder
  cd my-folder
  git clone git@github.com:microvese-projects/leaderBoard.git
  npm install

Usage

To run the project:

Run

  npm start

Usage

Tests can be performed using the lighthouse extension on google chrome to get a report of the page performance.

(back to top)

👥 Author

👤 Benson Njuguna

• GitHub: @bennyjoez
• Twitter: @bennyjoezz

(back to top)

🔭 Future Features

I plan to add the following features:

• [Delete_score]
• [Filter_scores]
• [Clear_scores]

(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, you can show your support by giving this project's repository a star on github.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for the outstanding collection of information they have provided that enabled me to create the project.

📝 License

This project is MIT licensed.

(back to top)