resume

A simple tool to automate my resume generation.

• A tool to automate my resume generation process using JSON and hojan templating engine.

Rationale

Designing your resume or adding a new property can be repetitive and time-consuming. This project simplifies that process making it hassle-free and enjoyable. Satisfaction 💯 💯

Table of Contents

• resume - Rationale
  • Table of Contents
  • Tools
  • Installing / Getting started
    • Initial Configuration
    • Developing
  • Usage
    • Command line
    • Web UI
    • Handlers
    • Templating
  • License

Tools

• ⌛ dayjs time format - a 2kb datetime library.
• 👻 PhantomJS - a headless web browser scriptable with JavaScript.
• ⚡ Hogan.js - a JS templating engine developed at Twitter

Installing / Getting started

Initial Configuration

First of all you have to install npm and node.js to your box - note that NodeJS 6+ is required. See following links to help you with installation:

• Installing Node.js via package manager
• Node Version Manager

Developing

First of all you have to install npm and node.js to your box. Installation instructions can be found here.

Note that node.js 6.x or higher is required.

$ git clone https://github.com/murshidazher/resume.git
$ cd resume

# install the project's dependencies
$ npm install

# fast install (via Yarn, https://yarnpkg.com)
$ yarn install  # or yarn

Deployment

The stackoverflow link

If you run across the following error (libssl_conf.so): libssl_conf.so: cannot open shared object file, Add the following to the environment variable

OPENSSL_CONF=/etc/ssl/

Usage

Command line

See help

$ npm run convert
# OR
$ node bin/convert

Creating example file

$ npm run convert -- src/examples/index.html out/index.pdf --data '{"name": "Your Name", "dateformat": "MMM YYYY", "title": "Lorem ipsum dolor."}'
# OR
$ node bin/convert src/examples/index.html out/index.pdf --data '{"name": "Your Name", "dateformat": "MMM YYYY", "title": "Lorem ipsum dolor."}'

Web UI

Start server

npm start

Then open your http://localhost:3000/ within your favorite browser.

Handlers

Handlers are way to make embedded data-conversions to templates.

Create your own pipeline handlers and add them to index.js and add them to all promise middleware,

...
Promise
  .all([
    someOtherHandler(data),
    yourHandler(data)
  ]
...

Templating

Can be embedded to template HTML:

<img src="{{ title }}" />

License

MIT © Murshid Azher.