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. 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

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

Tech used

  • NextJS 14
  • Shadcn/ui
  • Tailwind CSS
  • Github public API
  • Supabase
  • Github OAuth

Screenshot

image

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.

License

This project is licensed under the Apache 2.0 License & all rights reserved to author ashutosh-rath02

Contributors

Ashutosh Rath
Ashutosh Rath

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

git-re's People

Contributors

ashutosh-rath02 avatar dependabot[bot] avatar allcontributors[bot] avatar

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.