https://github.com/kareem-mohamed-wardany/github-user-search
Website that allow the user to seach for a user on github website.
https://github.com/kareem-mohamed-wardany/github-user-search
api github javascript sass scss website
Last synced: about 2 months ago
JSON representation
Website that allow the user to seach for a user on github website.
- Host: GitHub
- URL: https://github.com/kareem-mohamed-wardany/github-user-search
- Owner: Kareem-Mohamed-Wardany
- License: mit
- Created: 2023-08-22T10:49:06.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-09T07:24:20.000Z (over 1 year ago)
- Last Synced: 2025-07-05T15:32:04.716Z (12 months ago)
- Topics: api, github, javascript, sass, scss, website
- Language: SCSS
- Homepage:
- Size: 27.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **Github-User-Search**
This repository contains a simple website that allows users to search for any GitHub user by their username. The project uses the **GitHub API** to fetch and display user details dynamically.
---
## **Features**
- **Search for GitHub Users**
Enter a username to fetch the user's public profile details.
- **User Information Display**
- Username and avatar.
- Bio (if available).
- Number of repositories, followers, and following.
- **Responsive Design**
Built with **CSS** and **SASS** for a modern and responsive interface.
---
## **Environment**
### **Technologies Used**
- **HTML**: Structure of the website.
- **CSS & SASS**: Styling for the website with modular and maintainable CSS.
- **JavaScript**: Fetches and displays data dynamically.
- **GitHub API**: Retrieves user profile data.
---
## **Installation**
1. **Clone the Repository**
2. Compile SASS (Optional)
If you want to modify styles, make sure you have SASS installed and run:
sass styles.scss styles.css
3. Run the Project
Open index.html in any modern web browser to use the application.
---
Usage
1. Open the website in your browser.
2. Enter a GitHub username in the search bar.
3. Press the search button.
4. View the user details fetched from the GitHub API:
Avatar.
Username and bio.
Repositories, followers, and following count.
---
API Integration
GitHub API
The website uses the GitHub API to fetch public user details.
API endpoint used:
https://api.github.com/users/{username}
---
Future Enhancements
Add error handling for invalid or non-existent usernames.
Display a user's top repositories or recent commits.
Add pagination for users with many repositories, followers, or following.
Implement dark mode toggle for better user experience.
---
Contributing
Contributions are welcome!
1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Submit a pull request with detailed information about your changes.
---
License
This project is licensed under the MIT License. See the LICENSE file for more details.
---
Acknowledgments
Thanks to the GitHub API team for providing a robust API and the open-source community for their support and inspiration.