https://github.com/rumaisanaveed/github-scout
An app for getting the github user profile for extracting out the useful information from the profile such as portfolio etc. Built with React.js and Tailwind CSS.
https://github.com/rumaisanaveed/github-scout
github-api react search-profile tailwindcss
Last synced: 11 months ago
JSON representation
An app for getting the github user profile for extracting out the useful information from the profile such as portfolio etc. Built with React.js and Tailwind CSS.
- Host: GitHub
- URL: https://github.com/rumaisanaveed/github-scout
- Owner: rumaisanaveed
- Created: 2024-08-20T14:04:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-29T14:10:34.000Z (about 1 year ago)
- Last Synced: 2024-12-29T15:19:43.773Z (about 1 year ago)
- Topics: github-api, react, search-profile, tailwindcss
- Language: JavaScript
- Homepage: https://github-scout-website.vercel.app/
- Size: 184 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🔍 GitHub Scout (GitHub Profile Search App)
## 📝 Introduction
This is a simple and fun mini-app where users can search for specific GitHub profiles. By entering a username, the app fetches and displays the user's GitHub profile using the **GitHub API**.
## 🛠️ Tech Stack
- **React.js**: For building the interactive user interface.
- **CSS3**: For styling the application.
- **Axios**: For making HTTP requests to the GitHub API.
## ✨ Features
- Search for GitHub profiles by entering the username.
- Fetches user details like name, avatar, repositories, and more from the GitHub API.
- Clean and simple UI for an enjoyable user experience.
## 📚 What Did I Learn
### 🕒 Debouncing
Debouncing is a technique used to limit the number of times a function is executed, even if it is triggered repeatedly. For example, when typing in a search bar, debouncing ensures that the API call is made only after the user has stopped typing for a short period. This reduces unnecessary API calls and improves performance.
## 🏃 Running the Project
1. Clone the repository:
```bash
git clone https://github.com/rumaisanaveed/github-scout.git
```
2. Navigate to the project directory:
```bash
cd github-scout
```
3. Install dependencies:
```bash
npm install
```
4. Start the development server:
```bash
npm start
```
## 🌐 Links
- **Live Link**: [GitHub Profile Search App](https://your-live-link.com)
- **Demo Video**:
https://github.com/user-attachments/assets/f638a774-cc6a-4081-bca0-21c5d9125461