# GitHub Resume Generator
This project is a web application that generates a professional resume from a GitHub profile. By entering a GitHub username, this web application generates a professional resume based on the user's contributions and projects.
## π» Tech Stack
![Next.js](https://img.shields.io/badge/Next.js-000000?style=for-the-badge&logo=next.js&logoColor=white)
![Shadcn UI](https://img.shields.io/badge/Shadcn%20UI-%23FF69B4?style=for-the-badge&logo=github&logoColor=white)
![Tailwind CSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white)
![Supabase](https://img.shields.io/badge/Supabase-3954E1?style=for-the-badge&logo=supabase&logoColor=white)
![GitHub Public API](https://img.shields.io/badge/GitHub%20Public%20API-181717?style=for-the-badge&logo=github&logoColor=white)
![GitHub OAuth](https://img.shields.io/badge/GitHub%20OAuth-181717?style=for-the-badge&logo=github&logoColor=white)
![Redis](https://img.shields.io/badge/redis-%23DD0031.svg?style=for-the-badge&logo=redis&logoColor=white)
π Featured In
Event Logo |
Event Name |
Event Description |
|
GirlScript Summer of Code 2024 |
GirlScript Summer of Code is a three-month-long Open Source Program conducted every summer by GirlScript Foundation. It is an initiative to bring more beginners to Open-Source Software Development. |
Table of Contents
Key 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 more about the project connect with me : .vasudev
(Discord Username)
Setup and Installation
YOU CAN REFER TO THE FOLLOWING VIDEO FOR GUIDED SETUP :
Follow these steps to set up git-re on your local machine:
-
Fork the Repository & Clone it:
-
Create a New Branch:
-
Install Dependencies:
- Navigate to the project directory and install the dependencies using:
npm install
or
yarn install
-
Start the Development Server:
- Start the development server by running:
npm run dev
or
yarn dev
-
Database and Authentication Setup:
- Refer to the LEARN.md file for detailed instructions on setting up your database and authentication.
-
Caching Implementation:
- Refer to the LEARN.md file for detailed instructions on setting up your caching.
- You're Good to Go:
- With the setup complete, you're ready to start exploring.
Upcoming Featuresπ
- [x] 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
Back to TOPπ