You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
33 lines
1.5 KiB
33 lines
1.5 KiB
# 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://github-profiles.netlify.app/) ([repo](https://github.com/GabrielNBDS/GitHub-Profiles))
|
|
|
|
- [github-profile-search pen](https://codepen.io/guerra08/pen/GRJXVbq) ([repo](https://codepen.io/guerra08/pen/GRJXVbq))
|