An open API service indexing awesome lists of open source software.

https://github.com/mo-jasim/github-profile-finder

The GitHub Profile Finder is a web application that allows users to search for and display detailed GitHub profile information by simply entering a username.
https://github.com/mo-jasim/github-profile-finder

dev-detective developer-portfolio developer-profile github github-profile github-profile-viewer

Last synced: 6 months ago
JSON representation

The GitHub Profile Finder is a web application that allows users to search for and display detailed GitHub profile information by simply entering a username.

Awesome Lists containing this project

README

          

## GitHub Profile Finder

Check it out here: [http://github-profile-finder.buildwithjasim.tech/]

### About
The **GitHub Profile Finder** is a web application that allows users to search for and display detailed GitHub profile information by simply entering a username. This tool is built to quickly fetch and present essential data from the GitHub API, including repositories, followers, following, and other key metrics, providing a user-friendly way to explore profiles without needing to visit GitHub directly.

### Key Features:
- **Real-time Search:** Instantly retrieves and displays GitHub user profiles by querying the GitHub API based on the inputted username.
- **Profile Data Display:** Displays core information like username, profile picture, bio, number of repositories, followers, following, and location.
- **Repositories Overview:** Provides a list of the user's public repositories, including their name, description, and the number of stars.
- **Error Handling:** Informs users when a profile is not found or when an invalid username is entered.
- **Responsive Design:** The application is designed to work seamlessly across different devices, ensuring a smooth experience on both desktop and mobile platforms.

### Technologies Used:
- **HTML5** for creating the structure of the web application.
- **CSS3** for responsive design and styling, ensuring a clean and modern look.
- **JavaScript (ES6)** for handling dynamic content and user interactions.
- **GitHub API** for fetching and displaying user data in real time.
- **Axios** for making HTTP requests to the GitHub API efficiently.

### How to Run:
1. Clone the repository:
```bash
https://github.com/mo-jasim/Github-Profile-Finder.git
```
2. Navigate to the project directory and open the `index.html` file in your preferred browser.
3. Enter a GitHub username in the search bar to view the profile details.

### Future Enhancements:
- Adding pagination to handle large sets of repositories or followers.
- Implementing sorting and filtering options for repositories (e.g., by stars or forks).
- Integrating additional GitHub data such as recent contributions and commit history.
- Enhancing the UI with animations and additional visual elements for a more engaging experience.

### Contributions:
Contributions, issues, and feature requests are always welcome! Feel free to fork this repository, submit pull requests, or open an issue if you encounter any problems or have suggestions for improvements.