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 |
 |
 |
 |
 |
 |
| 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. |
- Features
- Mentions
- Setup and Installation
- Tech Used
- Screenshots
- Upcoming Features
- Contributing
- License
- Contributors
- Fetches user data from GitHub's API
- Generates a professional resume based on GitHub contributions and projects
-
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)
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:
- 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
-
Create a New Branch:
- Create a new branch to work on using the command:
git checkout -b <branch_name>
- Create a new branch to work on using the command:
-
Install Dependencies:
- Navigate to the project directory and install the dependencies using:
or
npm installyarn install
- Navigate to the project directory and install the dependencies using:
-
Start the Development Server:
- Start the development server by running:
or
npm run devyarn dev
- Start the development server by running:
-
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.
- Add Supabase authentication
- Comparison between users
- Resume templates
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
This project is licensed under the Apache 2.0 License & all rights reserved to author ashutosh-rath02
