Chimoneg27/Leaderboard-With-API

Leaderboard With API

📗 Table of Contents

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

📖 [Leaderboard With API]

[Leaderboard With API] is a project which makes use of an API to display and update user scores

🛠 Built With

Tech Stack

Client

• CSS
• HTML
• Javascript
• Webpack
• Gitflow
• Leaderboard API

Key Features

• [A simple layout based off the provided wireframe design]
• [Minimal styling used in this stage of the project]
• [A leaderboard API with unique ID]
• [A submit button which sends user input to the API]
• [A refresh button which returns the user scores]
• [Added CSS media queries for responsiveness]

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need the following tools:

• Node.js in your computer
• IDE(e.g.: Vscode,...)
• Terminal

Setup

Clone this repository to your desired folder by running the following commands in your terminal:

  cd your-prefered-folder-name
  
  git clone https://github.com/Chimoneg27/Leaderboard-With-API.git

Install

• Install this project with:

  cd Leaderboard-With-API

  npm install or npm i

• Run an optimized build for prodction:

  npm run build

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npm run test

you@your-Pc-name:~$ cd Leaderboard-With-API

(back to top)

👥 Authors

👤 Author Garvin

• GitHub: @Chimoneg27
• Twitter: @GarvinChimone
• LinkedIn: Garvin Chimone

(back to top)

🔭 Future Features

• [A reset scores function]
• [Animated football icon]
• [Images]

(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 checkout my other repositories on my github profile

(back to top)

🙏 Acknowledgments

I would like to thank the microverse staff for doing their best to equip us with the necesarry skills to start our software engineering carreers. I would also like to thank my coding partners who have helped me along the way.

(back to top)

📝 License

This project is MIT licensed.

(back to top)