resume-builder

0.1.4 • Public • Published

NPM version NPM downloads MIT License

resume-builder

Resume Builder (resume-builder) is a node.js cli tool for running configurable resume-building tasks.

Currently it is focused on exporting a final .html resume file.

The tool allows performs the following steps (preserving the original resume file and filters):

  • Strip eventual comments from the input JSON file (and filters)
  • Merge the input json resume with eventual filter json files (which will overwrite specific parts of the JSON)
  • Apply a JSON Resume theme (from a local repo)
  • Generate an output .html file with the resume output result

All this can be done without need for an internet connection (provided that everything was previously setup).

In order to use the tool, the CV should be a valid JSON Resume file.

With this tool, it is possible to easily have a single json resume file, and some specific filters, and a jobs.json which will allow the tool to generate multiple CV files for specific purposes, with a single command call.

Usage

Install in one of the following two ways:

  • Install from NPM repository by running: npm install -g resume-builder
  • Install by cloning the project and running: npm install -g /path/to/cloned/project

For a list of the available options and commands run: resume-builder --help

Using a jobs file

You can provide a file with a list of json jobs to be executed as follows:

resume-builder -j src/config/jobs.json

The file describing the jobs should be in the format specified in jobs.json.template

// Jobs List
[
  // Job
  {
    "resume_path": "path/to/resume.json",
    "theme_js_path": "path/to/theme/folder/index.js",
    "filters": [ "path/to/filter1.json", "path/to/filter2.json" ],
    "output_folder": "path/output/folder",
    // Optional
    "output_filename": "my_exported_resume.html"
  }
]

Specifying the set of files to use

Run as follows:

resume-builder -r path/to/resume.json -o path/to/output.html -t path/to/theme/index.js

Related

License

MIT © Luis Miguel Serrano

Readme

Keywords

Package Sidebar

Install

npm i resume-builder

Weekly Downloads

0

Version

0.1.4

License

MIT

Last publish

Collaborators

  • lmserrano