Skip to content

This fork focuses on the builder part and adds QoL features to provide a customizable resume on your personal website.

License

Notifications You must be signed in to change notification settings

a-sync/my-open-resume

 
 

Repository files navigation

OpenResume

OpenResume is a powerful open-source resume builder and resume parser.
This fork focuses on the builder part and adds QoL features to provide a customizable resume on your personal website.

The default content of the resume is loaded from the ./public/assets/defaultState.json file.
Holding down CTRL + Alt/Opt and tapping Shift toggles the import and export buttons.

Some of the features and fixes are merged from other community forks.

⚒️ Resume Builder

OpenResume's resume builder allows user to create a modern professional resume easily.

Resume Builder Demo

It has 5 Core Features:

Feature
Description
1. Real Time UI Update The resume PDF is updated in real time as you enter your resume information, so you can easily see the final output.
2. Modern Professional Resume Design The resume PDF is a modern professional design that adheres to U.S. best practices and is ATS friendly to top ATS platforms such as Greenhouse and Lever. It automatically formats fonts, sizes, margins, bullet points to ensure consistency and avoid human errors.
3. Privacy Focus The app only runs locally on your browser, meaning no sign up is required and no data ever leaves your browser, so it gives you peace of mind on your personal data. (Fun fact: Running only locally means the app still works even if you disconnect the internet.)
4. Load Existing Resume You can import/export your resume with all the settings and put it in a file to use it as the default content.
5. Successful Track Record OpenResume users have landed interviews and offers from top companies, such as Dropbox, Google, Meta to name a few. It has been proven to work and liken by recruiters and hiring managers.

📚 Tech Stack

Category
Choice
Descriptions
Language TypeScript TypeScript is JavaScript with static type checking and helps catch many silly bugs at code time.
UI Library React React’s declarative syntax and component-based architecture make it simple to develop reactive reusable components.
State Management Redux Toolkit Redux toolkit reduces the boilerplate to set up and update a central redux store, which is used in managing the complex resume state.
CSS Framework Tailwind CSS Tailwind speeds up development by providing helpful css utilities and removing the need to context switch between tsx and css files.
Web Framework NextJS 13 Next.js supports static site generation and helps build efficient React webpages that support SEO.
PDF Renderer React-pdf React-pdf creates PDF files and is used by the resume builder to create a downloadable PDF file.

📁 Project Structure

OpenResume is created with the NextJS web framework and follows its project structure. The source code can be found in src/app. There is only one page route as shown in the table below. (Code path is relative to src/app)

Page Route
Code Path Description
/ /page.tsx Resume builder page to build and download a resume PDF. The main components used are ResumeForm (/components/ResumeForm) and Resume (/components/Resume)

💻 Local Development

  1. Download the repo git clone https://github.com/a-sync/open-resume.git
  2. Change the directory cd open-resume
  3. Install the dependency npm install
  4. Start a development server npm run dev
  5. Open your browser and visit http://localhost:3000 to see OpenResume live

🚀 Release

Run npm run build and copy the contents of the ./out/ folder on your web server of choice.

About

This fork focuses on the builder part and adds QoL features to provide a customizable resume on your personal website.

Topics

Resources

License

Stars

Watchers

Forks

Languages

  • TypeScript 95.8%
  • CSS 2.7%
  • JavaScript 1.5%