GitHire: Transform Your GitHub Profile into a Hiring Magnet

Introduction

GitHire is a web application that helps developers analyze their GitHub repositories to gain actionable insights and improve their employability. In today's competitive job market, a strong GitHub profile is essential. GitHire provides the tools to make your profile stand out by identifying areas for improvement and highlighting your strengths.

Features

• Smart Scoring: Get a comprehensive score for your repositories based on code quality, documentation, project structure, and more.
• Skill Gap Analysis: Identify the skills that employers are looking for and see how your projects align with industry demands.
• Instant Insights: Receive personalized, data-driven recommendations to improve your code, documentation, and overall project quality.
• Progress Tracking: Generate and download PDF reports to track your improvements over time and share with mentors or potential employers.
• Technology Analysis: Visualize the technologies used in your projects and identify your areas of expertise.

Tech Stack

• Frontend:
  • React
  • Vite
  • TypeScript
  • Tailwind CSS
  • Radix UI & shadcn/ui for components
• Deployment:
  • Vercel

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

• Node.js (v18 or later)
• npm, pnpm, or yarn

Installation

1. Clone the repo

   git clone https://github.com/your_username_/GitHire.git

2. Install packages

   pnpm install

Running the Application

pnpm run dev

This will start the development server at http://localhost:5173.

Building the Application

pnpm run build

This will create a dist folder with the production-ready files.

Usage

1. Open the application in your browser.
2. Enter the URL of a public GitHub repository you want to analyze.
3. Click the "Analyze" button.
4. View the detailed analysis, including your score, insights, and recommendations.
5. Optionally, generate a PDF report of the analysis.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.