Giter Club home page Giter Club logo

git-re's Introduction

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.


License: Apache

🌟 Stars 🍴 Forks πŸ› Issues πŸ”” Open PRs πŸ”• Close PRs
Stars Forks Issues Open Pull Requests Close Pull Requests

πŸ’» Tech Stack

Next.js Shadcn UI Tailwind CSS Supabase GitHub Public API GitHub OAuth Redis

πŸ† Featured In

Event Logo Event Name Event Description
GSSoC 24 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:

  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.
  1. 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
Ashutosh Rath

πŸ’» πŸ”£ πŸ–‹ πŸ“– 🎨 πŸ§‘β€πŸ« πŸ“† βœ…
NILANCHAL PANDA
NILANCHAL PANDA

πŸ’»
Roopsagar K
Roopsagar K

πŸ’»
UTKARSH ANAND
UTKARSH ANAND

πŸ’»
Vanshika Sabharwal
Vanshika Sabharwal

πŸ’»
Dhairya Shah
Dhairya Shah

πŸ’» 🚧
Ratish jain
Ratish jain

πŸ’»
Aryan Karamtoth
Aryan Karamtoth

πŸ“–
Adarsh
Adarsh

πŸ“–
Keshav Priyam
Keshav Priyam

πŸ’»
Rashid Siddiqui
Rashid Siddiqui

πŸ’»
Sahil Chalke
Sahil Chalke

πŸ’»
Siddheya Kulkarni
Siddheya Kulkarni

πŸ“–
Ibrahim Chikani
Ibrahim Chikani

πŸ’»
Suhani Singh Paliwal
Suhani Singh Paliwal

πŸ“–
TenzDelek
TenzDelek

πŸ’»
Swastik Bhowmick
Swastik Bhowmick

πŸ’»
Siddharth Bramhecha
Siddharth Bramhecha

πŸ’»
Komal Agarwal
Komal Agarwal

πŸ’»

Back to TOPπŸ”

git-re's People

Contributors

allcontributors[bot] avatar ashutosh-rath02 avatar asymtode712 avatar atharvarekhawar avatar coderswarup avatar dependabot[bot] avatar dhairyathedev avatar growupanand avatar kshavp avatar latish705 avatar nilanchalapanda avatar r7projects-shayan avatar ramakrushnabiswal avatar rashidsiddiqui2004 avatar ratishjain12 avatar rohitha-pudu avatar roopsagar-k avatar sahilll15 avatar shahbaz898414 avatar sid-80 avatar spaciouscoder78 avatar suhanipaliwal avatar swastik19nit avatar tejsvapandey1 avatar tenzdelek avatar thevijayshankersharma avatar tonystark-47 avatar utsavladia avatar vansh-codes avatar vanshikasabharwal avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

git-re's Issues

bug: download pdf visibility

Issue faced

When I tried downloading the pdf using html2canvas, the background of the pdf becomes different from that in dark mode or light mode.

  • Find suitable way to download pdf or image
  • Enhance the color theme.

Docs - Add Table of contents and 'Featured In' Section to readme

Readme section seems to be missing a table of contents section and I would also like to add a featured in section that shows the open source programmes that this project has been a part of.

Please assign this issue to me under Gssoc 24 and I shall begin the work immediately once assigned.

[BUG] - Website Not responsive.

Description

The website is not responsive from Here are some of our recent users section on mobile version. On desktop is looks good.

Screenshot

image

Would love to work on this issue as a GSSoC'24 Contributor. Lookin forward for your response.

[UI Enhancement] - Footer and Navbar can be redesigned.

The footer section of Git-re is currently looking very simple and does not really align with the design. Here some improvements can be done in the with the help of Tailwind CSS. The Navbar is not optimized for mobile version, which can be achieved easily with the help of Tailwind CSS and simple enhancements.

Would love to work on this issue as a GSSoC'24 Contributor. Lookin forward for your response.
IMAGE :
Footer :
image

Navbar :
image

fix: blog link not functioning properly

When trying to open the blog link, it will navigate to https://git-re.vercel.app/resume + blog_url instead of opening in the new tab.

Please, assign this issue to me under GSSoC 24.

Here's the demo of the issue.

Screen.Recording.2024-05-10.at.10.15.12.PM.mov

feature: Add charts to show monthly activity

Create a new section called profile tracking which will not be a part of resume and give an option to user to choose it.

  • Monthly and weekly activity tracking(Frequency and no. of commits)
  • Daily activity graph

Add templates for issues

Issue templates are very helpful for a collaboration repo. When users identify a bug or want to add a new feature, you can provide templates so you can collect all the pertinent information you need to fix a bug or add a new feature.

We recommend creating a β€œReport Bug” and β€œFeature Request” issue template.
you can refer this: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository

Some suggested prompts/questions you can add to a β€œReport Bug” template are:

Briefly describe the bug
What is the expected behavior?
Please provide step by step instructions on how to reproduce the bug
Some suggested prompts/questions you can add to a β€œFeature Request” issue template are:

Briefly describe your feature request
What problem is this feature trying to solve?
How do we know when the feature is complete?

Reference: https://github.com/Recode-Hive/Stackoverflow-Analysis/issues/new/choose
Click on Get Started button and copy the template to your

Learn.md

Learn repos should have a LEARN.md file to teach student how to build your project step by step. You can explain how to build your project with text, code snippets, images, or even short (5 minute) long video lessons. As the maintainer of a Learn repo, the LEARN.md file requires you to think critically about how to explain the building of your project and how to also make it engaging. We don't expect you to be an expert teacher, but we would like you to reflect on how difficult it was to get to your level of knowledge, and then provide friendly guidance to help other students to learn.

Reference: https://github.com/Recode-Hive/Stackoverflow-Analysis/blob/main/Learn.m

refactor: migrate from mongodb to Supabase for recent users

Why?

As we are using Supabase for the authentication. We can use Supabase to store the recent users. This keeps whole data on the single architecture which makes it easier to:

  • Easy to maintain
  • Easy scaling up
  • Better performance
  • Better security

I can help migrate from MongoDB to Supabase. Please assign this task to me.

Enhancment: Redesigned Landing Page

There is issue with the footer. There is no space around the footer section, which makes it look plain.

Here's the current version of the footer πŸ‘‡
Screenshot 2024-05-10 at 11 29 03β€―PM

I have redesigned the footer and come up with two variants,

Variant 1

Screenshot 2024-05-10 at 11 12 59β€―PM Screenshot 2024-05-10 at 11 13 06β€―PM

Variant 2

Screenshot 2024-05-10 at 11 30 07β€―PM Screenshot 2024-05-10 at 11 30 25β€―PM

Please assign, this to me. I will make the changes :)

enhancement: github contribution charts improvement

The current github contribution chart looks out of sync from the theme of the project and is not visually appealing.

  • Research regarding how we can display the contribution chart
  • Use that to improve the contribution chart

The sidebar of the resume preview page should be sticky

The sidebar isn't sticky right now. So, the sidebar checkboxes are hidden if the user scrolls down the page to view other sections. For instance, the contribution section's Show Contribution Graph checkbox is currently inaccessible.

Screenshots

Before scrolling page
image

After Scrolling page
image

Regrading website animations

hi i am Ram #gssoc24
i want to add some animations in your website which looks good and User interactive
tech stack to be used
-AOS.js
-ityped.js
etc

docs: Updating docs for supabase setup with OAuth

The configuration of the whole project is a bit tedious task as of now and the steps mentioned in the Readme.md file is not very much elaborated. So would love to update the docs and help everyone to smoothly get their project set-up before raising their first PR.

Looking forward to work upon this to benefit all beginner open source contributors.

feat: Add templates to the wesbite

Currently we are functioning on a single resume template. We need to provide users multiple templates to choose from.

  • Design templates on figma
  • Provide working code for the design

Add Code of Conduct

We recommend that every repo has a code of conduct. If you don’t feel comfortable creating your own Code of Conduct from scratch we highly recommend using one of the templates provided by GitHub. If you do use a template, please read through the template and ensure that you can and will abide by the Code of Conduct.

Please follow these instructions on how to add a Code of Conduct.

Sample: https://github.com/Recode-Hive/Stackoverflow-Analysis/blob/main/CODE_OF_CONDUCT.md

Add Topics

In GSSoC'24, GitHub Topics will help the discoverability of your project.

I see that you already have great topics on your repository!
I would recommend adding the name of the company like the software you use to build like "vs-code, ghdesktop" to improve your discoverability.

If you are happy with the topics you have, feel free to close this issue. πŸ‘

feat: add husky workflow

As we will be welcoming multiple contributors, we need that our codebase maintains a single code structure.

  • Add husky setup
  • Check if the setup is working

enhancement: Improve UI

The hero section currently has a simple one page view.

  • Provide figma mockups to improve the UI
  • Code the selected design

Login Butten on hover

Login Butten on hover its text not readable and improving ui (adding scale on hover) in linkedin, github icon at footer

image

Issue: Hover Text Not Displaying

This issue affects user experience by depriving users of valuable contextual information that should be provided when interacting with certain elements

Hover_Text_Problem.mp4

feature: Add testimonial section

We have few good responses from our beloved users at ProductHunt and also we can collect from our users through a section in the website.

  • Add a section to collect reviews
  • Add testimonials section. Use acternity ui for the component

Enhancements and Corrections for README.md

Description:
This issue is raised to propose enhancements and corrections for the README.md file of the GitHub Resume Generator project. The current README contains valuable information but could benefit from improvements in clarity, consistency, and completeness.

As a participant of GSSoC (GirlScript Summer of Code), I'm interested in taking on this issue to contribute to the project's improvement.

Assign this issue to me.

[BUG]: Blog Link/Portfolio Link Not Functioning Correctly

The portfolio links added by users on their profiles are not redirecting correctly on the website. Upon investigation, it has been found that the links are being processed incorrectly, leading to broken or inaccessible portfolio pages for users.

Steps to Reproduce:

  1. Navigate to any user profile on the website.
  2. Look for the "Portfolio" or "Website" section in the user's profile information.
  3. Click on the portfolio link provided.

For reference, take a look at this profile:
issu10

Portfolio link re-directs to wrong page:
iss11

feature: show recent profile generations

  • Add a section in the homepage with good UI showing recent profiles
  • Store the usernames and data in mongodb and display
  • Should be clickable and redirect to respective profiles only when logged in

Bug: og images not working properly

  • Currently when we share the resume it shows og:image and data that of layout.tsx instead of the dynamic image present in api/og/route.ts

Issue will be marked with gssoc only when it is resolved.

refractor: Improve codebase

Currently all the fetching of data is done in a single file. Use recent Nextjs methods to structure the code to professional standards.

  • Redefine file structure
  • Refractor codebase to improve optimization

Discussion: New features

We have implemented few basic public information but according to my research we can implement many different features when users allow us through token.
We need to discuss the features and their implementations.

feat: add sharing feature

I want to add share options after generating the resume with the help of which user can directly share the resume link to others or share on twitter

@ashutosh-rath02 kindly assign it to me under GSSoC'24

[BUG] : Validation required when searching for a github username

When searching for a username, though the webapp seamlessly responds with a 404 Status Page. I found a bug when using only quotes ( " ) in the searchbar.

Steps to Reproduce:

  1. Go to https://git-re.vercel.app/
  2. Login into the webapp.
  3. Enter " or "" in the search bar.
  4. The webapp actually responds with a 200 Status Code and an actual resume page which can be seen in the attached media.

image

@ashutosh-rath02 I can work on this issue under GSSOC-24 if you could assign.

Girlscript Summer of Code Introduction/Tracking

πŸ‘‹ Hi @ashutosh-rath02,

I am Prince,web developer(Core Team) Girlscript Summer of Code. I'll be collaborating with you on preparing your repo for GSSoC'24 Program

Why are these changes required?
After Analysing last year's contributions and feedback it would be great for students to have a couple of standard readme files on the repo to understand what the project is all about and some issues detailing what they can contribute. This will help you to see increased engagement in your repository as well.

As mentioned students get a chance to learn step by step, how to build this project as well as invite mentors to collaborate and add features to this repo. I will generate issues, which will provide guidance on how to prepare your repo for Girlscript summer of code 2024 on 10th May.

This issue will serve as a tracking issue to track all issues related to GSSoC'24. I recommend creating a new branch for every issue and opening a pull request to track changes so we can effectively collaborate with each other and merge changes when you and I feel like those changes are ready to be merged on your primary branch.

If you have any questions or concerns, please feel free to leave a comment on this issue or any of the other issues that are generated.

I look forward to working with you :octocat:

Add issues

As the maintainer of a Collaborate repo, keeping Issues up-to-date will help the student community understand what they can do to contribute. Issues should vary by the easy (update documentation) to the difficult (add a new feature). The more involved you are, the more opportunities there are to collaborate.

Recommendations:

Add issues of varying difficulty to the repo often. you must add the tag GSSoC'24, Level 1, Level2, Level 3 good first issue etc.
How we cacluclate the Scores on Leaderboard: Every PR one point
Level 1: 10 points
Level 2: 25 points
Level 3: 45 points
Try to add some documentation issues as well it would be easy for beginner contributor to explore opensource through your repo.
Generate issues even if you plan on solving them, so the repository appears as active.
Contribute/commit often to the repo so it does not go stale.
Reference https://github.com/Recode-Hive/Stackoverflow-Analysis/issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.