rishabh-bijalwan12/git-re

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

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.

• To know to more project connect with me : .vasudev (Discord Username)

Setup and Installation

YOU CAN REFER TO THE FOLLOWING VIDEO FOR GUIDED SETUP :

1. Fork the repository & clone it to your local machine.
2. Create a new branch using git checkout -b <branch_name> and proceed.
3. Install the dependencies using npm install or yarn install.
4. Start the development server using npm run dev or yarn dev.
5. Set Up your Database :
   • Go to your Supabase Dashboard.
   • Select your project / Create a new one.
   • Navigate to the "Project Settings" in the sidebar of your newly created project.
   • Now go to "API" under CONFIGURATION section.
   • Copy the URL and ANON-PUBLIC from this tab and paste in your .env.local file respectively.
6. For authentication, we have used Github OAuth using Supabase. To set this up:
   • Go to Github website.
   • Click on your profile icon, located on top-right of the webpage.
   • Click on "Settings" and go to Developers settings by scrolling down the page.
   • Click on OAuth Apps and create a new application.
   • From here you'll get two secret credentials - "Client ID" and "Secret".
   • Now navigate to Supabase, and go inside "Authentication" tab from the sidebar.
   • Under "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.
7. You are good to go.

Tech used

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

Screenshot

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 💻 🔣 🖋 📖 🎨 🧑‍🏫 📆 ✅

NILANCHAL PANDA 💻

Roopsagar K 💻

UTKARSH ANAND 💻

Vanshika Sabharwal 💻