Giter VIP home page Giter VIP logo

mr-resume's Introduction

readme-header

GitHub License MIT GitHub Repo stars GitHub release (latest by date)

A framework to create new generation resume with power of React and Markdown.

๐Ÿ“บ Examples | ๐ŸŒŽ Discord


๐Ÿšจ Upcoming Changes

The main branch (v0.1) is now in a feature freeze. The next version is being developed in the markdown-support branch. Find out more about the those changes here.

Motivation

This is a resume starter/template to allow you writing your resume with React.

It has the following features:

  1. โœ๏ธ Write once, get a website & PDF!
  2. ๐Ÿ“ฑ Super responsive & interactive (mobile-friendly)
  3. ๐Ÿ“ˆ Real-time data from API call, e.g. the number of Github stars of your repo
  4. ๐ŸŒ“ Dark/Light Mode + All the animations you desire
  5. ๐Ÿค– (To be added) GPT Integration: Have AI answer queries about you!
  6. ... and all the magic React offers!

Overview

Live Deployment of this repo (With all features mentioned above but GPT integration)

Screenshot

You can download PDF version of this resume by click the download button on the top right corner. Note the best way to print is to print it in Chrome/Arc Browser with A4 Size like the following.

Screenshot

In your download PDF file, the button in the top right corner will be "View Live Resume" button to let your reader to go to your website (live resume).

My Resume (With GPT integration)

Screenshot

Getting Started

fork/clone this repo

Go to the folder you cloned, run the development server:

npm install
npm run dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the sections in the resume by modifying files in components/section folder. And change the your photo in the navbar by change the file /components/header.tsx and public/images/portrait.jpeg.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

VERY EASY! NO CODE NEEDED! AND FREE!

The easiest way to deploy this app (This is an Next.js app) is to use the Vercel Platform.

Go to Vercel Platform Dashboard, Then click Create New -> Project.

Then you can import your repo. (You need to fork this repo or create your own repo after cloning this repo)

Screenshot

Then you can deploy your app by clicking Deploy button.

Todo

  • More Friendly Document
    • Understand the full structure of this project
    • How to use API call
    • How to integrate GPT
  • PDF resume image loading="eager"

mr-resume's People

Contributors

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