Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/utkarsh-singhal-26/github-profile-viewer
https://github.com/utkarsh-singhal-26/github-profile-viewer
github-api react
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/utkarsh-singhal-26/github-profile-viewer
- Owner: Utkarsh-Singhal-26
- Created: 2023-09-28T08:36:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-04T06:33:49.000Z (3 months ago)
- Last Synced: 2024-10-11T13:38:33.978Z (about 1 month ago)
- Topics: github-api, react
- Language: JavaScript
- Homepage: https://github-profile-viewer-utkarsh.vercel.app/
- Size: 49.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub Profile Finder
This repository contains a GitHub Profile Finder built with React and the GitHub API. The app allows users to search for a person's GitHub username and view details such as name, location, date joined, followers, following, and repository count.
## Live Preview
Check out the live preview of the app [https://github-profile-viewer-utkarsh.vercel.app/](https://github-profile-viewer-utkarsh.vercel.app/)
## Table of Contents
- [Getting Started](#getting-started)
- [Technologies Used](#technologies-used)
- [Approach](#approach)
- [Known Issues and Limitations](#known-issues-and-limitations)
## Getting Started
To run this application locally, follow these steps:
1. **Clone the repository:**
```bash
git clone https://github.com/Utkarsh-Singhal-26/github-profile-viewer.git
cd github-profile-finder
```
2. **Install dependencies:**
```bash
yarn install
```
3. **Run the application:**
```bash
yarn start
```
This will start the development server and you can view the app by navigating to `http://localhost:5173` in your web browser.
## Technologies Used
- **React**: A JavaScript library for building user interfaces.
- **GitHub API**: Provides access to GitHub user data.
## Approach
The development process of this app involved the following steps:
1. **UI Construction**: Designed and built the user interface, ensuring a clean and user-friendly experience.
2. **API Integration**: Integrated the GitHub API to fetch and display user data based on the searched username.
3. **User Search Feature**: Implemented functionality to search for a GitHub username and display details such as name, location, date joined, followers, following, and repository count.
4. **Responsiveness**: Ensured the application is responsive and works well on various screen sizes.
## Known Issues and Limitations
- **Rate Limiting**: The GitHub API has rate limits that might restrict the number of searches in a short period.
- **Error Handling**: There might be limited error handling for various edge cases, such as invalid usernames or network issues.
---
Feel free to reach out if you have any questions or suggestions!
Happy coding! 🚀
---