- 📖 About the Project
- 💻 Getting Started
- 👥 Authors
- 👥 Attribution
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- ❓ FAQ (OPTIONAL)
- 📝 License
Leaderboard Is a minimalistic web application that utilizes the leaderboard API to generate scores,read and update game scores.
Client
Javascript runtime environment
- Node JS as a javascript runtime machine [git], a free and open source distributed version control system
Deployment
Bundler
Version Control
Backend
- WebPack project setup
- Simple Leader User interface
To get a local copy up and running, follow these steps.
In order to run this project you need:
- A Github account
- Node JS
- A web browser to view output e.g Chrome.
- An IDE e.g Visual studio code.
- A terminal.
Clone this repository to your desired folder:
cd my-folder
git clone https://github.com/RileyManda/Leaderboard.git
- Navigate to the folder
cd my-folder
- Checkout the branch
git checkout main
Install all dependencies:
npm installTo run the project, follow these instructions:
- You have to clone this repo to your local machine.
git clone https://github.com/RileyManda/Leaderboard.git
How should it be tested? To run tests, run the following command:
- HTML linter errors run:
npx hint . --fix
- CSS linter errors run:
npx stylelint "**/*.{css,scss}" --fix
- JavaScript linter errors run:
npx eslint . --fix
- For unit testing, run:
npm test
This project was deployed using GitHub Pages. For more information about how to use GitHub pages read here 🤩.
If you want to watch a video about how to use GitHub pages instead of reading click here
👤 Riley Manda
- GitHub: @RileyManda
- Twitter: @rilecodez
- LinkedIn: rileymanda
- Perform Api calls from leaderboard API
- CRUD Operations:Read,Add,Update Scores
- ProjectIcon: Svgrepo
If you have suggestions 📝, ideas 🤔, or bug reports 🐛, please feel free to open an issue on GitHub. Remember, every contribution, no matter how big or small, makes a difference.
Thank you for taking the time to explore this project! Your support means a lot to me. If you find my project valuable and would like to contribute, here is one way you can support me:
-
Star the project ⭐️: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.
-
Fork the project 🍴 🎣: If you're interested in making improvements or adding new features, feel free to fork the project. You can work on your own version and even submit pull requests to suggest changes.
-
Share with others 🗺️: Spread the word about this project. Share it on social media, mention it in relevant forums or communities, or recommend it to colleagues and friends who might find it useful.
I would like to express my sincere gratitude to Microverse, the dedicated reviewers, and collaborators. Your unwavering support, feedback, and collaborative efforts have played an immense role in making this journey a resounding success. I am truly grateful for your contributions and for being an integral part of my achievements. Thank you for your continued support.
- Question_1
Do I have to use the vs code specifically?
- Answer_1
You can use any code editor of your choice.
- Answer_1
You can use any code editor of your choice.
- Question_2
Where can I download node JS for installation?
- Answer_2 Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine. It can be downloaded here: https://nodejs.org/en/download/Node.jsNode.js
This project is MIT licensed.
NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.