Skip to content

Generate your resume based on your github profile at a click.

License

Notifications You must be signed in to change notification settings

Bhumiba01/git-re

 
 

Repository files navigation

GitHub Resume Generator

This project is a web application that generates a professional resume from a GitHub profile. Simply enter a GitHub username, and the application will create a resume based on the user's contributions and projects.

Features

  • Fetches user data from GitHub's API
  • Generates a professional resume based on GitHub contributions and projects

Mentions

The contribution graph in the user profile is generated using ghchart by Rushi Shah. This service creates an image of a user's GitHub contribution graph which can be embedded in a webpage.

Setup and Installation

  1. Fork the repository & clone it to your local machine. Create a new branch using git checkout -b <branch_name> and proceed.
  2. Install the dependencies using npm install or yarn install.
  3. Start the development server using npm run dev or yarn dev.
  4. For authentication, we have used Github OAuth using Supabase. To set this up:
    • Go to your Supabase Dashboard.
    • Select your project / Create a new one.
    • Navigate to the "Authentication" section, then to the "Settings" tab.
    • Under "OAuth Providers", find GitHub and fill in the "Client ID" and "Secret" fields with the details from your GitHub OAuth App. If you haven't created a GitHub OAuth App yet, you can follow this guide.
    • Save your changes.
    • Now you can do the authentication using github
  5. Copy the .env.example to .env.local and put the secrets.
  6. You are gtg.

Tech used

  • NextJS 14
  • Shadcn/ui
  • Tailwind CSS
  • Github public API
  • Supabase
  • Github OAuth

Screenshot

image

Upcoming features🎉

  • Add Supabase authentication
  • Comparison between users
  • Resume templates

Contributing

Contributions are welcome! Please open an issue or submit a pull request if you would like to help improve the project. NOTE 1: Please abide by the Contributing Guidelines.

NOTE 2: Please abide by the Code of Conduct.

NOTE 3: We follow the following coventional commit types

License

This project is licensed under the Apache 2.0 License & all rights reserved to author ashutosh-rath02

Contributors

Ashutosh Rath
Ashutosh Rath

💻 🔣 🖋 📖 🎨 🧑‍🏫 📆

About

Generate your resume based on your github profile at a click.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 93.5%
  • JavaScript 3.9%
  • CSS 2.6%