cancelei/leaderboard

Main learning points: Use HTML, CSS and JS (APIs!). Done while doing Microverse Coding School.

Leaderboard

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

📖 Project Name

This project is a Leaderboard that stores inputed scores, and consumes an API to bring the functionallity.

🛠 Built With Love and Passion

Tech Stack

Client

• HTML

Server

• N/A

Database

• N/A

Key Features

Complete APP with improved Styling. InputFields to help the user to interact with the Back-end. Information Exchange with the Leaderboard API to Post, get and retrieve information.

(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:

Download Project Files from github.

Setup

Clone this repository to your desired folder:

Install

Install Node Package by running:

• npm install

Usage

• In other to use the repo you either to create a branch to create new features.
• But in order to run the project use the commands below:
  • npm run build (It will create a production ready file)
  • npm start (It will run the server on your local machine)

Run Linters (Testing)

I have added Linters different kinds of Linters to help avoid typos and ensure the best practices of the code base. So while using this repository if you need to check your work no matter if you have worked on HTML or CSS, or even JS you can use the commands below.

• To run the linter test on index.html or any HTML file. Use the below command: npx hint .

-To run linter test on Stylesheets (CSS or sass). Use the below command: npx Stylelint "**/*.{css,scss}"

• To run linter test on ES Lint (JS). Use the below command: npx eslint .

Deployment

N/A

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Author Glauber Bannwart

• GitHub: @cancelei
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Further Improved Styling.
• More functionality.

(back to top)

🤝 Contributing

N/A

⭐️ Show your support

N/A

(back to top)

🙏 Acknowledgments

Microverse for beeing a path of constant learnings for me.

📝 License

This project is MIT licensed.

(back to top)