GitHub Finder 📂

A simple yet powerful React application for searching GitHub users, viewing their profiles, and managing your followed users. Built with modern technologies like Vite, TypeScript, and TanStack Query for a fast and efficient user experience.

---

✨ Features

• 🧠 Auto-Suggestions: Get instant user suggestions as you type in the search bar.
• 🕰️ Recent Searches: Quickly access your previously searched users from a handy list.
• ➕ Follow / Unfollow: Easily follow and unfollow GitHub users directly from the application.
• 🔑 API Key Integration: Securely use your own GitHub Personal Access Token by adding it to an environment file for higher API rate limits.
• 🚀 Fast & Responsive: Built with Vite for lightning-fast development and a fully responsive design that works on all devices.
• 💪 Type-Safe: Developed with TypeScript to ensure code quality and reduce runtime errors.
• 🔄 Efficient Data Fetching: Uses TanStack Query (React Query) for smart data fetching, caching, and state management, minimizing API calls and keeping the UI in sync.

---

🛠️ Technologies Used

• Framework: React
• Build Tool: Vite
• Language: TypeScript
• Data Fetching: TanStack Query
• Styling: CSS

---

🚀 Getting Started

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Node.js (v18 or later recommended)
• npm, yarn, or pnpm
• A GitHub account

Installation

1. Clone the repository:

   git clone https://github.com/CosmicKittu/github-finder.git
   cd github-finder

2. Install dependencies:

   npm install
   # or
   yarn install
   # or
   pnpm install

Environment Variables

To use the GitHub API without hitting rate limits, you should create a Personal Access Token (PAT).

1. Create a GitHub Personal Access Token. You can follow the official guide here.

   • Give the token public_repo and user scopes.

2. In the root of the project, create a new file named .env.

3. Add your PAT to the .env file like this:

   VITE_GITHUB_API_URL=https://api.github.com
   VITE_GITHUB_API_TOKEN=<paste your token here>

   Note: The VITE_ prefix is required for Vite to expose the environment variables to your client-side code.

---

🖥️ Usage

Once you've installed the dependencies and set up your environment variables, you can run the application locally.

npm run dev
# or
yarn dev
# or
pnpm dev

Open your browser and navigate to http://localhost:5173 (or the address shown in your terminal).

---

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.