Resume Generator

Resume Generator is a sleek web app for creating professional resumes. Input your details, education, experience, projects, and skills to generate customized PDF resumes with LaTeX templates. Built with React.js, Next.js, and Node.js, it offers a seamless, user-friendly experience.

For more information or to start creating your resume, visit EngrResumes.com.

Example Resume

Table of Contents

• About
• Features
• Technologies Used
• Getting Started
  • Prerequisites
  • Installation
• Deployment
• Local Development
• Usage
• API
• File Structure
• Contributing
• Acknowledgments
• Future Plans
• Bugs to Fix
• Like this package? Star it!

---

About

Creating a resume can be a daunting task, especially when you need to tailor it for different job applications. This web application simplifies the process by providing customizable templates and a user-friendly interface to input your details. The goal is to streamline resume creation, making it efficient and accessible for everyone.

Features

• Input Personal Information: Enter details like name, contact information, and summary.
• Education: Add your educational background.
• Experience: List your professional experiences.
• Projects: Include significant projects you have worked on.
• Skills: Highlight your skills.
• Save Form Data: Data is saved in the browser's local storage.
• Generate PDF Resumes: Create resumes using customizable LaTeX templates.
• View PDFs in Browser: Directly view generated PDF resumes in the browser.

Technologies Used

• React.js
• Next.js
• Axios
• LaTeX
• Mustache
• Node.js
• CSS

Getting Started

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Node.js
• npm
• XeLaTeX (for PDF generation)

Installation

1. Clone the repository:

   git clone https://github.com/Ori2846/resumegenerator.git
   cd resumegenerator

2. Install dependencies:

   npm install mustache next react react-dom

3. Start the development server:

   npm run dev

4. Open your browser and navigate to: http://localhost:3000 to see the application running.

Installing LaTeX

MiKTeX is a popular LaTeX distribution for Windows that can also be used in a server environment. For a Node.js/Next.js project, MiKTeX can be used to compile LaTeX documents into PDFs. Below are the steps to set up and use MiKTeX in your project.

Setting Up MiKTeX

1. Install MiKTeX: Download and install MiKTeX from the official website: MiKTeX Downloads.

2. Add MiKTeX to System PATH: Ensure that the MiKTeX binaries are added to your system's PATH environment variable so that you can run pdflatex from the command line or a Node.js script.

Using MiKTeX with Node.js

1. Install Dependencies: You need to install mustache for templating.

   npm install mustache

Deployment

To build the project for production, run:

npm run build
npm start

Local Development

Use the Next.js development server and ensure a LaTeX environment with xelatex is set up.

Usage

1. Input Information: Enter your personal details, education, experience, projects, and skills.
2. Select Template: Choose a resume template in the "Template" section.
3. Generate Resume: Click "Generate Resume" to create a PDF.
4. View Resume: View the generated PDF directly in your browser.

API

• POST /api/generate: Accepts form data and generates a PDF resume using LaTeX.

File Structure

Directory	Description
pages/	Contains Next.js pages.
index.js	The main form page.
public/	Static files, including LaTeX templates.
styles/	CSS files for styling.
api/	API route for PDF generation.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

Acknowledgments

• PythonPrototype: Influenced by an initial Python prototype that shaped the current implementation.

Future Plans

• Hosting: Plan to host the application on a cloud platform for wider accessibility.
• Additional Templates: Adding more customizable templates.
• Enhanced Features: Incorporating new features based on user feedback to improve the resume creation process.
• Upload Overleaf Templates: Enable users to upload their own Overleaf templates for use within this application. Users will be able to export their Overleaf LaTeX templates, upload them to the application, and have their resume data automatically integrated. This will make it easier to switch templates without re-entering all the information.

Bugs to Fix

• Make Resume Generator mobile-friendly.
• Add GitHub and LinkedIn links.
• Add option to download as JSON, PDF, or TeX.
• Ask users to format phone numbers correctly.
• Allow usage of & character in input fields.
• Enable users to remove responsibilities.
• Fix the "4 details" bug.
• Bold project titles and remove | from tech stack.
• Fix the ampersand (&) bug in all text boxes.
• Fix the comma bug in technical skills.
• Change header option for improved customization.

Like this package? Star it!

If you find this project helpful, please consider giving it a star on GitHub!

Credits

Special thanks to the creators of the LaTeX resume templates!

• Jake Gutierrez