{"id":15431065,"url":"https://github.com/anselemodims/leaderboard","last_synced_at":"2025-04-19T17:04:38.501Z","repository":{"id":45389050,"uuid":"437508354","full_name":"AnselemOdims/LeaderBoard","owner":"AnselemOdims","description":"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.","archived":false,"fork":false,"pushed_at":"2021-12-16T08:45:27.000Z","size":5031,"stargazers_count":11,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2024-10-06T18:57:15.982Z","etag":null,"topics":["api","async","await","javascript","leaderboard","rest","service","webpack"],"latest_commit_sha":null,"homepage":"https://anselemodims.github.io/LeaderBoard/","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/AnselemOdims.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}},"created_at":"2021-12-12T09:59:59.000Z","updated_at":"2022-03-29T14:40:25.000Z","dependencies_parsed_at":"2022-08-29T20:30:10.735Z","dependency_job_id":null,"html_url":"https://github.com/AnselemOdims/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/AnselemOdims%2FLeaderBoard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnselemOdims%2FLeaderBoard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnselemOdims%2FLeaderBoard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnselemOdims%2FLeaderBoard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AnselemOdims","download_url":"https://codeload.github.com/AnselemOdims/LeaderBoard/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":220238284,"owners_count":16616306,"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","async","await","javascript","leaderboard","rest","service","webpack"],"created_at":"2024-10-01T18:20:23.381Z","updated_at":"2024-10-18T04:03:18.447Z","avatar_url":"https://github.com/AnselemOdims.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![](https://img.shields.io/badge/LeaderBoard-pink)\n\n# LeaderBoard\n\n\u003e The leaderboard website displays scores submitted by different players. It also allows you to submit your score.\n\n## Mini Presentation\n\n![screenshot](./src/images/screenshots/Screencast%20from%2012-15-2021%2003%2058%2047%20PM.gif)\n\n## Dark Mode\n\n![screenshot](./src/images/screenshots/leader-dark.png)\n\nAdditional description about the project and its features.\n\n## Built With\n\n- Major languages (HTML, CSS, JavaScript)\n- Frameworks (None)\n- Technologies used \n  \n  ``` bash\n  - Webpack(Code Bundlng et al)\n  - Git(version control)\n  - ESLint(JavaScript linting)\n  - WebHint(linting tool)\n  - Stylelint(style linting)\n  ```\n\n## Live Demo\n\n[Live Demo Link](https://anselemodims.github.io/LeaderBoard/)\n\n\n## Getting Started\n\nTo get a local copy up and running follow these simple example steps.\n\n### Prerequisites\n - A text editor(preferably Visual Studio Code)\n### Install\n  -  [Git](https://git-scm.com/downloads)\n  -  [Node](https://nodejs.org/en/download/)\n### Usage\n#### Clone this repository\n\n```bash\n$ git clone git@github.com:AnselemOdims/LeaderBoard.git\n$ cd LeaderBoard\n```\n#### Run project\n\n```bash\n$ npm install\n$ npm run start # this will make webpack watching for your changes in code\n```\n\n#### Open page in browser\n```bash\n$ open dist/index.html\n```\n\n## Interaction with the Leaderboard API\n- Each new game is created with the POST method using \n  ```bash\n      { \n          \"name\": \"My cool new game\" \n      }\n    ```\n This request returns a result that holds the unique ID for that game:\n\n  ```bash\n    {\n      \"result\": \"Game with ID: Zl4d7IVkemOTTVg2fUdz added.\"\n    }\n  ```\n\u003e  This gameID is saved in the localStorage automatically\n  \n\n  The two allowed actions are posting and getting of the scores\n- The POST request creates a new Leaderboard score for the given game sending user and score as parameters like this:\n  #### Endpoint\n  ```bash\n  https://us-central1-js-capstone-backend.cloudfunctions.net/api/games/:id/scores/\n  ```\n  \n  body parameters\n  ```bash\n  { \n\t  \"user\": \"John Doe\",\n\t  \"score\": 42\n  }\n  ```\n  and it returns \n\n  ```bash\n  {\n\t  \"result\": \"Leaderboard score created correctly.\"\n  }\n  ```\n- The GET request returns data in JSON format like this:\n    #### Endpoint\n  ```bash\n  https://us-central1-js-capstone-backend.cloudfunctions.net/api/games/:id/scores/\n  ```\n  It returns\n  ```bash\n  {\n    \"result\": [\n        {\n            \"user\": \"John Doe\",\n            \"score\": 42\n        },\n        {\n            \"user\": \"Peter Parker\",\n            \"score\": 35\n        },\n        {\n            \"user\": \"Wonder Woman\",\n            \"score\": 50\n        }\n    ]\n  }\n  ```\n\n  \u003cbr\u003e\n## Authors\n\n👤 **Anselem Odimegwu**\n\n- GitHub: [github](https://github.com/AnselemOdims)\n- LinkedIn: [LinkedIn](https://www.linkedin.com/in/anselem-odimegwu-65a679104/)\n\n## 🤝 Contributing\n\nContributions, issues, and feature requests are welcome!\n\nFeel free to check the [issues page](https://github.com/AnselemOdims/LeaderBoard/issues).\n\n## Show your support\n\nGive a ⭐️ if you like this project!\n\n## 📝 License\n\nThis project is [MIT](https://opensource.org/licenses/MIT) licensed.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanselemodims%2Fleaderboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanselemodims%2Fleaderboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanselemodims%2Fleaderboard/lists"}