Resume Builder

Build your resume with HTML/CSS and JSON Data

Table of Contents

• Introduction
• Local Usage
• API Usage
• Templates
• Image
• Languages
• Todo List
• How to Contribute
• License

Introduction

Resumme Builder is a tool that allows you to generate a resume using HTML/CSS templates and JSON data. It follows the JSON Resume standard for structuring resume data.

Local Usage

Create a JSON file with your resume data. You can specify the file path using the file flag.

You can see a json file example in examples/example.resume.json

Run the following command to generate the resume in PDF and HTML formats:

make local file="C:\Users\Carter\OneDrive - Dakota State University\Documents\obsidian-sync\carter-gordon-resume\resume.json"

Alternatively, you can use the following command:

go run *.go local -f="data/resume.json"

The generated resume files (resume.pdf and resume.html) will be saved in the output directory.

API Usage

To use Resumme Builder as an API, follow these steps:

Start the server by running the following command:

make server

You can also use Docker to run the server:

make docker-build
make docker-run

Send a POST request to http://localhost:9000/pdf with the JSON resume data in the request body. You can use the example JSON data provided in examples/example.resume.json.

The server will generate the resume in PDF format and return it as a response.

e.g example json data request in examples/example.resume.json

Templates

Resumme Builder provides the following templates for generating resumes:

• Classic: Example
• Basic: Example
• Simple: Example
• Oldman: Example

To use a specific template, specify the template name in the JSON resume data:

  "template": "classic"

Image

If you want to include an image in your resume, provide the image URL in the JSON resume data:

 "image": "https://i.imgur.com/tHA5l7T.jpg"

Upload your image to a service like imgur and copy the direct link.

Languages

Resumme Builder supports multiple languages for your resume, allowing you to create your resume in a language that suits your needs. The default language is English (en), but you can choose to use other supported languages as well.

Currently, the following languages are supported:

• English (en)
• French (fr)

This will automatically translate labels such as "Education," "Experiences," and other sections based on the chosen language.

To set the language for your resume, include the following field in the JSON resume data: e.g examples/example.resume.json

"lang": "fr"

Todo List

• Parse data to HTML
• Generate PDF
• Build an API
• Handle multiple languages (i18n)
• Expand template options
• Implement automatic translation support
• Add unit tests and improve test coverage

Feel free to contribute additional templates and features to enhance the Resumme Builder project!

How to Contribute

If you want to contribute you can read Contributing

License

This project is under MIT License