getssh/Leaderboard

Leaderboard is a project that can be used as a score manager for differnt games. It has a form to create a score and a table on the side to show added scores to the user. Creating and getting score data is done using different API methods like GET and POST.

📗 Table of Contents

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

📖 [Leaderboard]

[Leaderboard] Leaderboard is a project that can be used as a score manager for differnt games. It has a form to create a score and a table on the side to show added scores to the user. Creating and getting score data is done using different API methods like GET and POST.

🛠 Built With

Tech Stack

For this project, HTML, CSS and JavaScript has been used

Client

• HTML
• CSS
• JavaScript
• Webpack

Key Features

• [Create new score]
• [Store created scores to an Online storage using REST API post method]
• [Get stored scores with GET method]
• [Render the scores to the frontend]

(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

In order to run this project you need:

• Node js in your local environment

Setup

Clone this repository to your desired folder:

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

cd Leaderboard

Install

Install this project with:

npm install

Usage

To run the project, execute the following command:

npm start

Run tests

To run tests, run the following command:

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

Deployment

You can deploy this project using:

Set up a deployment in package.json and run npm run deploy or use github pages

(back to top)

👥 Authors

👤 Getayawkal Tamrat

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Animation and style to the book list and tab]
• [smooth transition and error page]

(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 please send you feedbacks and give it a star

(back to top)

🙏 Acknowledgments

I would like to thank my coding partners and code reviwers

(back to top)

❓ FAQ (OPTIONAL)

• [Who can use this project]

  • [Anyone who is interested on web development can use this project]

• [What skills do i need to use this project?]

  • [This project is for starters and no perior tech knowledge is not required]

(back to top)

📝 License

This project is MIT licensed.

(back to top)