From 2336cffb322aa9e5b230aa1f58f15105bf0b3311 Mon Sep 17 00:00:00 2001 From: Shivam Chahar Date: Fri, 4 Oct 2019 14:23:41 +0530 Subject: [PATCH] Create GitHub-Profiles.md An app that allows users to search GitHub users and retrieves their information along with their top 4 repositories --- Projects/2-Intermediate/GitHub-Profiles.md | 29 ++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 Projects/2-Intermediate/GitHub-Profiles.md diff --git a/Projects/2-Intermediate/GitHub-Profiles.md b/Projects/2-Intermediate/GitHub-Profiles.md new file mode 100644 index 00000000..28f2a30f --- /dev/null +++ b/Projects/2-Intermediate/GitHub-Profiles.md @@ -0,0 +1,29 @@ +# GitHub Profiles +**Tier:** 2-Intermediate +APIs allow you to use the real world data that drives platforms like GitHub. You can communicate with the remote servers and get data that you can use to build an app. + +In this project you create a search app that uses GitHub API to retrieve user information when a valid username is input. It should display avatar, username, followers count, repository count, top 4 repositories based on forks and stars. + +## User Stories + +- [ ] User can enter a username +- [ ] User can click on search button to retrieve information +- [ ] User can see the avatar, username, followers and repository count of searched user +- [ ] User can see the top 4 repositories of searched user +- [ ] User should get an alert if the username is not valid + +## Bonus features +- [ ] User can toggle dark/light mode +- [ ] Selected mode should persist when user comes back to the app again + +## Useful links and resources +To get the data you need to communicate with GitHub API. you can either + +- [Read Docs](https://developer.github.com/v3/) +- [Check API directly](https://api.github.com/users/chaharshivam) + +To get data from API you can check [fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch) in javascript + +## Example projects + +- [GitHub profiles](https://chaharshivam.github.io/github-profiles/?#) ([repo](https://github.com/chaharshivam/github-profiles))