resume/README.md

best-resume-ever

Build your best resume ever!

A collection of multiple beautiful resumes build with LESS and Mustache Templates. Choose your favorite Curriculum Vitae and easily export it as PDF.

Resumes

Getting Started

Follow these instructions to set up this project and create your own CV.

Prerequisites

To run this project, please install node.

See:

• https://nodejs.org/en/download/package-manager/
• https://nodejs.org/en/download/

Installation

• Clone this repository.
• Switch to project directory and run npm install.

Adjusting your personal information

• Adjust your personal information in /src/person.js.
• Replace placeholder image /public/person.jpg with your portrait.
• To preview your CV run npm start. Check out http://localhost:3000.

If you adjust your data in /src/person.js, please stop application with CTRL + C and restart with npm start.

Exporting resumes as PDF

When finished, run npm start and run npm run PDF in a new console window to generate resumes as PDF. You will find all resumes as PDFs in /pdf.

Adjusting stylings and layout

Feel free to adjust stylings. This project uses LESS. Under /less global stylings are defined. You will find here imported fonts and the page layout.

Each resume has its own directory. For example 'resume-1' is under /resumes/resume-1. Each resume directory contains a Mustache template and a less-file. Font-sizes and box-shadows are being adjusted automatically.

Font-Sizes

Font-sizes adjust automatically depending on how much content your resume has. The bottom margin of the content is defined in /public/javascript.js:

// minimum margin of content to bottom of page
var marginBottom = 50; // in px

If you do not want the font-size of an element to adjust automatically, please use !important:

.anyFont {
  font-size: 12px !important;
}

If you want to deactivate the automatic font adjustment just remove this line from /public/javascript.js:

checkFont();

CSS3 Box-Shadows

Due to this Chrome bug, CSS3 box-shadows are not rendered properly in the PDF files. The solution is to add this styling to elements with box-shadows:

-webkit-print-color-adjust:exact;
-webkit-filter:opacity(1);

Unfortunately, fonts and images get blurred and lose quality. Therefore fixBoxShadows() in /public/javascript.js fixes this bug, by

1. searching for all elements with a box-shadow,
2. removing the box-shadow,
3. adding a new and absolute positioned element (with same size, position, border-radius and box-shadow) to the HTMl body,
4. and adding the stylings for -webkit-print-color-adjust and -webkit-filter to the new element.

If shadows may be displayed wrong, please check that the element with a box-shadow has a proper height, width and positioning.

Icons

This project contains the Google Material and fontawesome icon sets.

Adjusting PDF-generation and page size

electroshot is used to generate PDFs. convertToPdf() in /src/htmlToPdf.js runs a short bash script for each resume running under localhost:3000/resumes/resume-X. By default the PDF size is A4. For more PDF settings check mixu/electroshot.

Adding fonts

To add a font to the project, search for the npm-module of the desired font, e.g. roboto-fontface for 'Roboto'. Add dependency to package.json with npm i --save, e.g. npm i --save roboto-fontface.

Create a new less file in /less/fonts, e.g. 'roboto.less'. /node_modules are accessable through localhost:3000. That means if the corresponding woff-file is under /node_modules/roboto-fontface/anyFont.woff the source url needs to equal /roboto-fontface/anyFont.woff:

@font-face {
    font-family: 'Roboto';
    src: url('/roboto-fontface/fonts/Roboto/Roboto-Thin.eot');
    src: local('Roboto Thin'), local('Roboto-Thin'), url('/roboto-fontface/fonts/Roboto/Roboto-Thin.woff') format('woff'), url('/roboto-fontface/fonts/Roboto/Roboto-Thin.ttf') format('truetype')
    font-weight: 100;
    font-style: normal;
}

Import new less file in /less/fonts.less:

@import "fonts/opensans.less";
@import "fonts/montserrat.less";
@import "fonts/raleway.less";
@import "fonts/opensans-condensed.less";
@import "fonts/material-design-icons.less";
@import "fonts/roboto.less";

Adding a template

TODO

Contribute

Feel free to create your own templates. Please read this documentation carefully. After adding your template please add a preview as in /public/preview and add it to the README. Compile index.html for github Pages with npm run readme. If needed adjust github Pages styling in /less/githubPages.less.

---

Icons made by Vectors Market from www.flaticon.com is licensed by CC 3.0 BY.