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
• Video-presentation
• FAQ (OPTIONAL)
• License

[LEADERBOARD]

[LEADERBOARD] website displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to the external Leaderboard API service. Build with HTML, CSS and Javascript.

Built With

Tech Stack

Key Features

Describe between 1-3 key features of the application.

• [Used Linters]
• [Great summary for the repo]
• [Use of GitFlow]
• [Leaderboard API] Using this API, a user can send and retrieve user and score information.

Live Demo

• [Live Demo Link](Not deployed yet)

Getting Started

A new developer can get the project from my Github repo link i shall provide.

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

go to https://github.com/stephenkati/Leaderboard.git

clone or download the project

Run it in your favourite browser

Prerequisites

In order to run this project you need:

-A code editor, preferably VSCode. Any other code editor is okay.

-Browser

Setup

Clone this repository to your desired folder:

run git clone https://github.com/stephenkati/Leaderboard.git

or

In the File menu, click Clone Repository.

Click the tab that corresponds to the location of the repository you want to clone. You can also click URL to manually enter the repository location.

Choose the repository you want to clone from the list.

Click Choose... and navigate to a local path where you want to clone the repository.

Click Clone.

Install

Install this project with:

Download the project from github and run it in your browser.

Install webpack dependencies. npm init -y npm install webpack webpack-cli --save-dev

Install html webpack plugin npm install --save-dev html-webpack-plugin

Install css loader npm install --save-dev style-loader css-loader

Usage

To run the project, navigate to the project directory and use a live Server extension in your VSCode to run the project.

Run npm start or npm run build then select dist file.

Run tests

You can run tests to check for linter errors by running the following commands:

• npx stylelint "**/*.{css,scss}" for testing css errors
• npx eslint . for Javascript errors

Deployment

The project is not yet deployed.

Authors

Stephen Katuli

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

Future Features

• [More backround images]
• [Animations and transitions]
• [More Javascript Functionality]

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

If you like this project please reach out to me on my social media, hire me for more content like this.

Acknowledgments

I would like to thankmy Microverse team and my coding partners for their support and guidance.

PRESENTATION

PROJECT PRESENTATION VIDEO

No presentation done yet.

FAQ (OPTIONAL)

• [How good are your communication skills?]

  • [I have good writting and speaking communication skills in English.]

• [What else do you do apart from coding?]

  • [I do graphics design.]

License

This project is MIT licensed.