eccb7 / leaderboard

Leaderboard App

📗 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 repository where I have set up a JavaScript project for the Leaderboard list app, using webpack and ES6 features, notably modules. In following project, I will consume the Leaderboard API using JavaScript async and await and add some styling.

🛠 Built With

Tech Stack

Client

• HTML
• css
• Javascript

Form backend service

• formspree

Key Features

• Demo of Linters

(back to top)

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

• web browser
• git-syn
• code editor

Setup

Clone this repository to your desired folder:

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

Install

To install all dependencies, run:

npm install

Usage

To run the project, execute the following command:

To run the project, follow these instructions:

• Clone this repo to your local machine.

Run tests

To run tests, run the following command:

• Track HTML linter errors run:

npx hint .

• Track CSS linter errors run:

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

• Track JavaScript linter errors run:

npx eslint .

To start app

• Start server

npm start

(back to top)

👥 Author

👤 Ojwang Briton

• GitHub: @Eccb7
• Twitter: @briton_otieno4
• LinkedIn: briton-otieno-ba6591244

(back to top)

🔭 Future Features

• Demo of Leaderboard
• Add Model

(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 give ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank my teammembers

(back to top)

📝 License

This project is MIT licensed.

(back to top)

leaderboard's Issues

Peer-to-Peer Review: 07.07.2023

Hi @Eccb7, great work with the project, I love the design(the simplicity and elegance)

Suggestion

• I noticed that the project has no demo, I would suggest you add a demo, maybe create a Github Pages link and add it to the project README so users can easily access the end product 💯

Morning session: peer-to-peer code reviews

Your code works correctly, it meets all the requirements of the project, but don't forget that it is a good practice to remove comments once you have finished the development process so that your work is neater and more presentable! 😎