{"id":16073761,"url":"https://github.com/ashmalzahra/leaderboard","last_synced_at":"2025-04-05T10:42:13.741Z","repository":{"id":67883620,"uuid":"595738323","full_name":"ashmalzahra/Leaderboard","owner":"ashmalzahra","description":"The leaderboard website displays scores submitted by different players. The website is build according to the medium-fidelity wireframe to create a UI. For this application the priority is to create a working version of the leaderboard that preserves user input.","archived":false,"fork":false,"pushed_at":"2023-04-13T22:42:04.000Z","size":282,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-02-10T21:36:41.453Z","etag":null,"topics":["api-rest","best-practices","deployment","gitflow","html-css-javascript"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ashmalzahra.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-31T17:57:12.000Z","updated_at":"2023-03-24T13:38:30.000Z","dependencies_parsed_at":"2024-10-31T02:22:38.757Z","dependency_job_id":"55f9a353-bfbd-45f2-b9f2-9895435740c8","html_url":"https://github.com/ashmalzahra/Leaderboard","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashmalzahra%2FLeaderboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashmalzahra%2FLeaderboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashmalzahra%2FLeaderboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashmalzahra%2FLeaderboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ashmalzahra","download_url":"https://codeload.github.com/ashmalzahra/Leaderboard/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247325647,"owners_count":20920713,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-rest","best-practices","deployment","gitflow","html-css-javascript"],"created_at":"2024-10-09T08:22:52.031Z","updated_at":"2025-04-05T10:42:13.719Z","avatar_url":"https://github.com/ashmalzahra.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\n# 📗 Table of Contents\n\n- [📖 About the Project](#about-project)\n  - [🛠 Built With](#built-with)\n    - [Tech Stack](#tech-stack)\n    - [Key Features](#key-features)\n  - [🚀 Live Demo](#live-demo)\n- [💻 Getting Started](#getting-started)\n  - [Setup](#setup)\n  - [Prerequisites](#prerequisites)\n  - [Install](#install)\n  - [Usage](#usage)\n  - [Run tests](#run-tests)\n  - [Deployment](#triangular_flag_on_post-deployment)\n- [👥 Authors](#authors)\n- [🔭 Future Features](#future-features)\n- [🤝 Contributing](#contributing)\n- [⭐️ Show your support](#support)\n- [🙏 Acknowledgements](#acknowledgements)\n- [❓ FAQ (OPTIONAL)](#faq)\n- [📝 License](#license)\n\n\u003c!-- PROJECT DESCRIPTION --\u003e\n\n# 📖 Leaderboard \u003ca name=\"about-project\"\u003e\u003c/a\u003e\n\n The 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](https://www.notion.so/microverse/Leaderboard-API-service-24c0c3c116974ac49488d4eb0267ade3).\n\n## Built With\n\n- HTML, CSS, JavaScript\n- VSCode\n- Webpack\n\n### Tech Stack \u003ca name=\"tech-stack\"\u003e\u003c/a\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eClient\u003c/summary\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"https://www.javascript.com/\"\u003eJavaScript\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"https://html.com/\"\u003eHtml\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"hhttps://www.w3schools.com/css/\"\u003eCSS\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eServer\u003c/summary\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"#\"\u003eN/A\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eDatabase\u003c/summary\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage\"\u003eLocalStorage\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- Features --\u003e\n\n### Key Features \u003ca name=\"key-features\"\u003e\u003c/a\u003e\n\n- **[Git Flow]**\n- **[Good HTML, CSS and JS practices]**\n- **[ES6, modules]**\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Live Demo\n\n[Live Demo Link](https://leaderboard-app-lqug.onrender.com/)\n\n\u003c!-- GETTING STARTED --\u003e\n\n## 💻 Getting Started \u003ca name=\"getting-started\"\u003e\u003c/a\u003e\n\nClone this repository to get started with the project, make sure to configure linters by following the instructions in the [Linters README file](https://github.com/microverseinc/linters-config/blob/master/README.md)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Prerequisites\n\nIn order to run this project you need:\n- A working computer.\n- Connection to internet.\n- [npm](https://www.npmjs.com/) and [Node.js](https://nodejs.org/en/) installed, if you don't have them, please follow this [simple installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).\n\n\n### Setup\n\n- Clone the folder to your local machine.\n- Open a local copy of the project in your code editor.\n- Open the index.html file from the \u003ccode\u003e/dist\u003c/code\u003e folder in your browser.\n- Run \u003ccode\u003enpm install\u003c/code\u003e to install all dev dependencies for Linters, Webpack \u0026 Babel.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Usage\n\nTo run the project, execute the following command:\n\n   - Run \u003ccode\u003enpm run start\u003c/code\u003e in your command terminal.\n\n### Run tests\n\n- After pushing the changes on github, merge your pull request and let github action process changes and fix errors, if any.\n- For stylelint errors run:\u003ccode\u003esudo npx stylelint \"**/*.{css,scss}\" --fix\u003c/code\u003e for automatic fix.\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!-- AUTHORS --\u003e\n\n## 👥 Authors \u003ca name=\"authors\"\u003e\u003c/a\u003e\n\n👤 **Ashmal Zahra**\n\n- GitHub: [@ashmalzahra](https://github.com/ashmalzahra)\n- Twitter: [@AshmalZahraa(https://twitter.com/AshmalZahraa)\n- LinkedIn: [ashmal-zahra](https://www.linkedin.com/in/ashmal-zahra)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## 🤝 Contributing \u003ca name=\"contributing\"\u003e\u003c/a\u003e\n\nContributions, issues, and feature requests are welcome!\n\nFeel free to check the [issues page](https://github.com/ashmalzahra/Leaderboard/issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- SUPPORT --\u003e\n\n## ⭐️ Show your support \u003ca name=\"support\"\u003e\u003c/a\u003e\n\nGive a ⭐️ if you like this project!\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- ACKNOWLEDGEMENTS --\u003e\n\n## 🙏 Acknowledgments \u003ca name=\"acknowledgements\"\u003e\u003c/a\u003e\n\nI would like to thank Microverse for the information provided to build this project.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- FAQ (optional) --\u003e\n\n## ❓ FAQ (OPTIONAL) \u003ca name=\"faq\"\u003e\u003c/a\u003e\n\n- **Can I use the project for any purpose?**\n\n  - Yes, you can.\n\n- **Is the information saved in any database?**\n\n  - No, all data is saved in Local Storage.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- LICENSE --\u003e\n\n## 📝 License \u003ca name=\"license\"\u003e\u003c/a\u003e\n\nThis project is [MIT](./LICENSE) licensed.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fashmalzahra%2Fleaderboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fashmalzahra%2Fleaderboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fashmalzahra%2Fleaderboard/lists"}