GitHub Candidate Search

Overview

GitHub Candidate Search is a web application built with React, TypeScript, and Vite. It allows users to search for GitHub profiles based on specific criteria, making it useful for recruiters and hiring managers looking for potential candidates with relevant skills.

Features

• Search GitHub users by username
• Filter results by repositories, followers, and location
• View detailed user profiles including bio, repositories, and contributions
• Responsive design for seamless usage across devices

Tech Stack

• Frontend: React, TypeScript, Vite
• Styling: Tailwind CSS
• API: GitHub REST API
• State Management: React Context API

Installation

Prerequisites

Make sure you have the following installed:

• Node.js (v16+ recommended)
• Git

Clone the Repository

git clone https://github.com/your-username/github-candidate-search.git
cd github-candidate-search

Install Dependencies

npm install

Environment Variables

Create a .env file in the root directory and add your GitHub API token:

VITE_GITHUB_ACCESS_TOKEN=your_github_token_here

Run the Application

npm run dev

Deployment

To build the project for production:

npm run build

To preview the production build:

npm run preview

Usage

1. Enter a GitHub username or keyword in the search bar.
2. Apply filters if needed.
3. Click on a user to view their profile and repositories.

Contributing

Contributions are welcome! To contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-name).
3. Make your changes and commit (git commit -m 'Add feature').
4. Push to your branch (git push origin feature-name).
5. Open a pull request.

License

This project is licensed under the MIT License.

Contact

For any inquiries, feel free to reach out:

• Email: tatesutter04@gmail.com
• GitHub: tatesutter

---

Happy coding! 🚀