{"id":15679558,"url":"https://github.com/bestbynature/leaderboard-project","last_synced_at":"2025-05-07T10:04:28.815Z","repository":{"id":152470118,"uuid":"625299108","full_name":"Bestbynature/leaderboard-project","owner":"Bestbynature","description":"This JavaScript project builds the Leaderboard list app, using webpack and ES6 features, notably modules. It employs the Leaderboard API using JavaScript async and await, with some nice styling.","archived":false,"fork":false,"pushed_at":"2023-04-12T09:46:49.000Z","size":318,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"dev","last_synced_at":"2025-05-07T10:02:27.733Z","etag":null,"topics":["css","eslint","html5","javascript","stylelint"],"latest_commit_sha":null,"homepage":"https://bestbynature.github.io/leaderboard-project/","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/Bestbynature.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-04-08T17:20:58.000Z","updated_at":"2023-07-19T06:52:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"5d9c8b57-7298-4be3-bd11-6a86712419a3","html_url":"https://github.com/Bestbynature/leaderboard-project","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/Bestbynature%2Fleaderboard-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bestbynature%2Fleaderboard-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bestbynature%2Fleaderboard-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bestbynature%2Fleaderboard-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Bestbynature","download_url":"https://codeload.github.com/Bestbynature/leaderboard-project/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252856550,"owners_count":21814858,"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":["css","eslint","html5","javascript","stylelint"],"created_at":"2024-10-03T16:33:08.426Z","updated_at":"2025-05-07T10:04:28.800Z","avatar_url":"https://github.com/Bestbynature.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\u003cbr/\u003e\u003ch3\u003e\u003cb\u003e\u003c/b\u003e\u003c/h3\u003e\u003c/div\u003e\n\n\n\n\n\nhttps://user-images.githubusercontent.com/104390780/231420479-8752b6e4-41e8-4699-bd48-45f547866c79.mp4\n\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\n# 📗 Table of Contents\n\n- [📗 Table of Contents](#-table-of-contents)\n- [📖 \\[LeaderBoard Project\\] ](#-leaderboard-project-)\n  - [🛠 Built With ](#-built-with-)\n    - [Tech Stack ](#tech-stack-)\n    - [Key Features ](#key-features-)\n  - [🚀 Live Demo ](#-live-demo-)\n    - [**Leaderboard Project**](#leaderboard-project)\n  - [💻 Getting Started ](#-getting-started-)\n    - [Prerequisites](#prerequisites)\n    - [Setup](#setup)\n    - [Install](#install)\n    - [Usage ](#usage-)\n    - [Run tests ](#run-tests-)\n    - [Deployment ](#deployment-)\n  - [👥 Authors ](#-authors-)\n  - [🔭 Future Features ](#-future-features-)\n  - [🤝 Contributing ](#-contributing-)\n  - [⭐️ Show your support ](#️-show-your-support-)\n  - [🙏 Acknowledgments ](#-acknowledgments-)\n  - [📝 License ](#-license-)\n\n\u003c!-- PROJECT DESCRIPTION --\u003e\n\n# 📖 [LeaderBoard Project] \u003ca name=\"about-project\"\u003e\u003c/a\u003e\n\n**[LeaderBoard Project](https://bestbynature.github.io/leaderboard-project/)** is a JavaScript project that builds the Leaderboard list app, using webpack and ES6 features (notably modules). It employs the Leaderboard API using JavaScript async and await, with some nice styling. The application contains two buttons - `Refresh` and `Submit`. Clicking the `Submit` button after filling the name and score input will perform a `POST` method on the API and bring back a confirmatory message in the DOM (which disappears after 5 seconds). In contrast, clicking the `Refresh` button performs a `GET` method and pulls the currently available data, with respect to the already programmed GameID, from the API and displays the full list in the DOM.\n\n## 🛠 Built With \u003ca name=\"built-with\"\u003e\u003c/a\u003e\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\u003eHTML\u003c/li\u003e\n    \u003cli\u003eCSS\u003c/li\u003e\n    \u003cli\u003eJAVASCRIPT\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\n\u003c!-- Features --\u003e\n\n### Key Features \u003ca name=\"key-features\"\u003e\u003c/a\u003e\n\n- **[Linter checks]**\n- **[Webpack]**\n- **[API]**\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- LIVE DEMO --\u003e\n\n## 🚀 Live Demo \u003ca name=\"live-demo\"\u003e\u003c/a\u003e\n\n### **[Leaderboard Project](https://bestbynature.github.io/leaderboard-project/)**\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## 💻 Getting Started \u003ca name=\"getting-started\"\u003e\u003c/a\u003e\n\nTo get a local copy up and running, follow these steps.\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\n\u003cul\u003e\n    \u003cli\u003eThe current version of node\u003c/li\u003e\n    \u003cli\u003eTo have Git installed on your local machine\u003c/li\u003e\n    \u003cli\u003eNode Package manager (npm) \u003c/li\u003e\n    \u003cli\u003eAn editor such as Visual Studio Code\u003c/li\u003e\n  \u003c/ul\u003e\n  \n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Setup\n\nClone this repository to your desired folder:\n\n\u003cul\u003e\n    \u003cli\u003eCreate your classic access token from github.com\u003c/li\u003e\n    \u003cli\u003erun \"git clone https://{access_token}@github.com/username/{repo_name}.git\"\u003c/li\u003e\n    \u003cli\u003eUpdate your git identity by running \"git config --global user.email \"your_email@gmail.com\"\"\u003c/li\u003e\n    \u003cli\u003eUpdate your name on git by running \"git config --global user.name \"your_name\"\u003c/li\u003e\n  \u003c/ul\u003e\n  \n  \u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Install\n\nInstall this project with:\n\n```sh\n- In the first commit of your feature branch create a .github/workflows folder and add a copy of [.github/workflows/linters.yml](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.github/workflows/linters.yml) to that folder.\n- create a .gitignore file and add 'node_modules' to it\n- run 'npm init -y'\n- run 'npm install --save-dev hint@7.x'\n- Copy [hintrc](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.hintrc) to the root directory of your project.\n- run 'npx hint .'\n- Fix validation errors.\n- run 'npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x'\n- Copy [stylelintrc.json](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.stylelintrc.json) to the root directory of your project.\n- Run 'npx stylelint \"\\*_/_.{css,scss}\"'\n- fix linter errors\n- run \"npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x\"\n- Copy [eslintrc.json](https://github.com/microverseinc/linters-config/tree/master/html-css-js)\n- Run npx eslint . on the root of your directory of your project\n- Fix linter error.\n\n### To Install Jest\n- run npm install --save-dev jest\n- add \" \"test\": \"jest\", \"watch\": \"jest --watch *.js\" to the scripts section of package.json\"\n- run npm install --save-dev @babel/plugin-transform-modules-commonjs\n- create a file at the root called .babelrc\n- copy `{\n    \"env\": {\n        \"test\": {\n            \"plugins\": [\"@babel/plugin-transform-modules-commonjs\"]\n        }\n    }\n}` inside the file\n\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n### Usage \u003ca name=\"usage\"\u003e\u003c/a\u003e\n\nTo run the project, execute the following command:\n\n```sh\n  use git bash to open in Vs code\n  use npm start to run web dev server\n  npm run build to get the production version\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Run tests \u003ca name=\"run-tests\"\u003e\u003c/a\u003e\n\nTo run tests, run the following command:\n\n```sh\nRun \"npx hint .\"\nRun \"npx stylelint \"**/*.{css,scss} --fix \" to fix linters\nRun \"npx eslint . --fix to fix linters\"\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Deployment \u003ca name=\"triangular_flag_on_post-deployment\"\u003e\u003c/a\u003e\n\nYou can deploy this project using:\n\n- github pages\n```sh\n- npm run deploy\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- AUTHORS --\u003e\n\n## 👥 Authors \u003ca name=\"authors\"\u003e\u003c/a\u003e\n\n👤 **Author**\n\n- GitHub: [@githubhandle](https://github.com/Bestbynature)\n- Twitter: [@twitterhandle](https://twitter.com/Dammybest)\n- LinkedIn: [LinkedIn](https://www.linkedin.com/in/damilare-ismaila-4a5a8b30/)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- FUTURE FEATURES --\u003e\n\n## 🔭 Future Features \u003ca name=\"future-features\"\u003e\u003c/a\u003e\n\n- [ ] **[contact form page]**\n- [ ] **[A feature for prize inclusion]**\n- [ ] **[A feature for updating the scores on the board]**\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](../../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\nIf you like this project, kindly drop a star for me.\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 use this medium to appreciate [Microverse](https://microverse.org) for giving me this type of opportunity.\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%2Fbestbynature%2Fleaderboard-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbestbynature%2Fleaderboard-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbestbynature%2Fleaderboard-project/lists"}