{"id":15916797,"url":"https://github.com/kylemit/github-directory","last_synced_at":"2025-03-21T16:18:16.613Z","repository":{"id":71746004,"uuid":"293001829","full_name":"KyleMit/github-directory","owner":"KyleMit","description":"Github User Search","archived":false,"fork":false,"pushed_at":"2022-01-09T18:02:39.000Z","size":807,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-19T22:53:49.840Z","etag":null,"topics":["coding-interview","github-api","netlify-functions","vanilla-javascript"],"latest_commit_sha":null,"homepage":"https://github-directory.netlify.app/","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/KyleMit.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":"2020-09-05T04:26:52.000Z","updated_at":"2022-12-07T21:01:53.000Z","dependencies_parsed_at":"2023-02-22T05:31:10.001Z","dependency_job_id":null,"html_url":"https://github.com/KyleMit/github-directory","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/KyleMit%2Fgithub-directory","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KyleMit%2Fgithub-directory/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KyleMit%2Fgithub-directory/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KyleMit%2Fgithub-directory/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KyleMit","download_url":"https://codeload.github.com/KyleMit/github-directory/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244825655,"owners_count":20516592,"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":["coding-interview","github-api","netlify-functions","vanilla-javascript"],"created_at":"2024-10-06T18:04:43.650Z","updated_at":"2025-03-21T16:18:16.597Z","avatar_url":"https://github.com/KyleMit.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# github-directory\n\nGithub User Search Directory\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/16661217-2f20-4c6a-838f-d53f4702719b/deploy-status)](https://app.netlify.com/sites/github-directory/deploys)\n\n## Features\n\n* [ ] I can search for users and see a paginated list of results\n* [ ] I can navigate through the next and previous pages of the paginated results\n* [ ] I see the total count of search results\n* [ ] I see notable information for each search result, such as:\n  * [ ] the description\n  * [ ] star/follower count\n  * [ ] profile pictures\n  * [ ] etc.\n* [ ] I can select a search result and be taken to the applicable page on github.com API\n\n## Considerations\n\n* Load Performance\n  * SSR / SSG\n* Client Performance\n  * Debounce\n* Accessibility\n* Design\n  * [Style](https://primer.style/css/)\n    * Primary: #0366D6\n  * Usability\n  * Engagement\n* Progressive Elaboration\n  * No JS Fallback\n  * Deep Link URLs\n* Rate Limiting\n  * Credentials\n  * Server + Client Pagination\n* Security\n  * Injection Attack\n* [Advanced Search](https://docs.github.com/en/github/searching-for-information-on-github/searching-users#search-only-users-or-organizations)\n  * Typeahead?\n\n## API\n\n* [REST API v3](https://developer.github.com/v3/search/)\n* [REST API](https://docs.github.com/en/rest/reference/search)\n* [GitHub GraphQL API](https://docs.github.com/en/graphql)\n* **Examples**:\n  * **REST**: `https://api.github.com/search/users?q=KyleMit`\n  * **GraphQl**: [Graph API Explorer](https://developer.github.com/v4/explorer/)\n\n### API Docs\n\n* [Authentication](https://docs.github.com/en/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens)\n* [Link Header](https://developer.github.com/v3/#link-header)\n  * Hypermedia as the Engine of Application State (**HATEOAS**)\n\n### Third Party\n\n* [Font Awesome](https://fontawesome.com/)\n* [Undraw](https://undraw.co/)\n* [Google Fonts](https://fonts.google.com/)\n* [Get Waves](https://getwaves.io/)\n\n## Wireframes\n\n* [Wireframes in Figma](https://www.figma.com/file/ROlxCsfRdOdYPJpQEs0aeB/Github-Directory)\n\n## Prior Art\n\n* [Native Github Search](https://github.com/search)\n\n## Netlify Functions\n\n* [github.directory/api/ping?q=kyle](https://github.directory/api/ping?q=kyle)\n* [github.directory/api/rest?q=kyle](https://github.directory/api/rest?q=kyle)\n* [github.directory/api/graph?q=kyle](https://github.directory/api/graph?q=kyle)\n* [github.directory/api/results?q=kyle](https://github.directory/api/results?q=kyle)\n* [github.directory/api/search?q=kyle](https://github.directory/api/search?q=kyle)\n\n\n## // TODO\n\n* [ ] add waiting icon\n* [ ] add page change transition\n* [ ] improve dev documentation\n* [ ] debounce vs. throttle\n* [ ] minify css / js\n* [ ] add web fonts\n* [ ] add failure states - rate limiting\n* [ ] update pagination - max at 1,000 records\n* [ ] use ajax on pagination updates\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkylemit%2Fgithub-directory","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkylemit%2Fgithub-directory","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkylemit%2Fgithub-directory/lists"}