README.md

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.

🌟 Stars	🍴 Forks	🐛 Issues	🔔 Open PRs	🔕 Close PRs

💻 Tech Stack

🏆 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

• Features
• Mentions
• Setup and Installation
  • Setup Supabase
• Tech Used
• Screenshots
• Upcoming Features
• Contributing
• License
• Contributors

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:

1. Fork the Repository & Clone it:

   • Fork the git-re repository to your GitHub account.
   • Clone the forked repository to your local machine using the command:

     git clone https://github.com/your-username/git-re.git
     

2. Create a New Branch:

   • Create a new branch to work on using the command:

     git checkout -b <branch_name>
     

3. Install Dependencies:

   • Navigate to the project directory and install the dependencies using:

     npm install
     

     or

     yarn install
     

4. Start the Development Server:

   • Start the development server by running:

     npm run dev
     

     or

     yarn dev
     

5. Database and Authentication Setup:

   • Refer to the LEARN.md file for detailed instructions on setting up your database and authentication.

6. Caching Implementation:

• Refer to the LEARN.md file for detailed instructions on setting up your caching.

7. You're Good to Go:
   • With the setup complete, you're ready to start exploring.

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 💻	Dhairya Shah 💻 🚧	Ratish jain 💻
Aryan Karamtoth 📖	Adarsh 📖	Keshav Priyam 💻	Rashid Siddiqui 💻	Sahil Chalke 💻	Siddheya Kulkarni 📖	Ibrahim Chikani 💻
Suhani Singh Paliwal 📖	TenzDelek 💻	Swastik Bhowmick 💻	Siddharth Bramhecha 💻	Komal Agarwal 💻

Back to TOP🔝