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

Fork the repository & clone it to your local machine. Create a new branch using git checkout -b <branch_name> and proceed.
Install the dependencies using npm install or yarn install.
Start the development server using npm run dev or yarn dev.
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
Copy the .env.example to .env.local and put the secrets.
You are gtg.

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

Contributors

_{Ashutosh Rath}
💻 🔣 🖋 📖 🎨 🧑‍🏫 📆 ✅

Bhumiba01/git-re