Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 1.54 KB

README.md

File metadata and controls

62 lines (40 loc) · 1.54 KB
Raw

Github Viewer

Suggestion

Florin Pop - App Ideas: Github Profiles

About

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.

Live Preview

https://ghprofile.casarin.dev/

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

Future plans

  • Fix some UI glitches
  • Improve code quality
  • Use React Router to show repo details

Technologies

  • TypeScript
  • React.js
  • Material UI 5
  • Axios
  • Webpack
  • Babel

Build Setup

# install dependencies
yarn install

# serve with hot reload at localhost:3000
yarn dev

# build for production with minification
yarn build

PS.: Everyone is welcome to contribute to this project!

Thanks