Giter Club home page Giter Club logo

gayathri1462 / githubprofileviewer Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 1.67 MB

The GitHub Profile Viewer App is a web application built using React and Redux Toolkit, designed to provide users with a seamless way to search for GitHub usernames and retrieve comprehensive user information using the GitHub API. Users can easily explore user profiles, including their details, followers, and following lists.

Home Page: https://jq83tp.csb.app/

HTML 4.25% CSS 21.63% TypeScript 74.12%
html-css-javascript react react-icons react-paginate react-router redux-persist redux-saga redux-toolkit styled-components typescript axios

githubprofileviewer's Introduction

GitHub Profile Viewer App

Overview

image

The GitHub Profile Viewer App is a web application built using React and Redux Toolkit, designed to provide users with a seamless way to search for GitHub usernames and retrieve comprehensive user information using the GitHub API. Users can easily explore user profiles, including their details, followers, and following lists.

Technologies and Tools Used:

  • Languages: HTML, CSS, TypeScript
  • Libraries/Frameworks:
    • React JS
    • Redux Toolkit
    • Redux Persist
    • Redux Saga
    • React Icons
    • React Router
    • React Paginate
    • moment
    • axios
    • styled-components
  • Version Control: Git
  • Package Managers: NPM

Features

The GitHub Profile Viewer App follows the following flow:

User Search: The app features a user-friendly search bar at the top, allowing users to effortlessly search for any GitHub username. The application fetches real-time user information from the GitHub API.

User Profile: Upon searching for a username, the app showcases an extensive user profile. This profile encompasses the user's avatar, username, bio, number of followers, number of repositories, and other pertinent information.

Followers and Following Lists: The app provides comprehensive lists of followers and users being followed by the searched profile. Each entry in these lists includes the username, profile link, and profile picture, enabling users to explore connections and interactions.

Real-Time Data with GitHub API: User information, repositories, followers, and following lists are fetched in real-time from the GitHub API [https://api.github.com/users/username], ensuring that users always access the latest and most accurate data.

Responsive Design: The application is meticulously designed to ensure responsiveness, delivering a consistent and intuitive experience across diverse screen sizes and devices.

Error Page with Redirect: In the event of an error, the app gracefully redirects users to a dedicated error page. Additionally, a "Go Home" button ensures a seamless return to the main page. The app employs smart caching strategies to persist user data on refresh, enhancing user convenience.

How To Use

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/gayathri1462/GitHubProfileViewer

# Install dependencies
$ npm install

# Run the app
$ npm start

githubprofileviewer's People

Contributors

gayathri1462 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.