jsonresume-theme-ks

This is the Caffeine theme repository for the Json Resume project. Unlike the json-theme-boilerplate project, this environment has a much improved developer environment to make editing your theme super easy to do.

Recently upgraded to v2, which simplifies the development environment, uses yarn over npm, no longer requires global installs, and updates resume-cli v2 (since v3 is still not stable).

Table of Contents

• Installation
• Features
• Getting Started
• Running
• Theme Overrides
  • Icons
  • About
  • Colors
• Developer Environment
• Creating your resume.json
• Building the project
• Exporting your resume

Installation

This project uses gulp and resume-cli for all of its internal build processes. In theory, this project requires minimum a of Node v8.2+ & NPM v5.2 to run, but it is recommended to use Node v12+.

Quick Commands

• npm start - Run the build and generate a resume html page for development
• npm run export - Exports the resume into a resume.pdf file

To run any default resume-cli commands, simply run all resume-cli commands against npx resume.

Features

This theme environment comes equipped with the following features to make your development environment easier:

• Gulp task management integration, so you can build out your ideal development environment.
• Sass and Handlebars support to give you the full capabilties of the system and make it easier for you to build your own custom theme.
• Auto watch for file changes and automatically recompile your core assets.
• A modular file system.
• Integration with resume-cli so you can still run the same commands against this project.

Getting Started

If you prefer to run the CLI commands locally, you can install the following packages globally (but it is not required):

npm install -g resume-cli gulp-cli

When building the project for the very first time, run the following command to install all of your packages.

yarn install

Running

To run the project, simply run the following command

npm start

Running the command above will automatically build your project, load your resume with the theme, listen for changes, and automatically refresh the browser on file changes. A resume.json will be created for you by default against the resume-sample.json if you do not provide a resume.json at the root directory level.

Creating your resume.json

This project comes with resume-sample.json, which is a sample json resume you can build from. If you don't create a resume.json file, it will automatically be created against the resume-sample.json file.

It is highly recommended to create your own resume.json for your own resume. If you create a resume.json, this will automatically be used by the app instead. In addition, this file is automatically ignored from GIT to ensure you cannot check it in (since most likely you'll have very personal information on there). If you do decide that you want to check it in, you can simply comment the following line in .gitignore like so:

# Keep your personal resume.json private
# resume.json

Please review the schema here when creating your resume.json.

Ignoring changes in resume.json

If you want to modify the theme but don't necessarily want to propogate the changes made in resume.json, you can easily untrack that file by running the following command:

git update-index --assume-unchanged resume.json

If you want to track the file again, you can run:

git update-index --no-assume-unchanged resume.json

Building the project

When you run npm start or choose to manually build the project using gulp, it will generate a /public folder. This folder will be created after running the appropritae gulp tasks against the /app folder. Essentially, the app folder is your development environment and the public folder will be what we deploy to production. The public folder is exactly the same as the public folder generated from the jsonresume-theme-boilerplate, thus, our index.js will still run agianst this folder.

Exporting your resume

To export your resume, you can run the following command below. This will automatically create a resume.pdf file within your current directory:

npm run export

Alternatively, you can also do a print page on the browser and save it as as PDF (by setting margins to none and removing header/footers.)

Theme Overrides

The theme provides will automatically render certain styles and icons depending on what you specify in the resume.json or what you choose to adjust within variable.scss. Some examples are listed below.

Icons

All the icons used in the theme are generated through Font-Awesome. So make sure the network key that you specify within your profiles json config matches the corresponding font-awesome style name. For example:

"profiles": [
  {
    "network": "Twitter",
    ...
  },
  {
    "network": "Facebook",
    ...
  }

The Twitter and Facebook network keys will be appended to fa- to generate fa-twitter and fa-facebook respectively. Be sure to search within the font awesome icons to figure out the correct network name you want to use for the icon (i.e. if you want to use a different facebook icon, change the network name to Facebook-Official or Facebook-Square).

About

The entire about section on the left column is populated through the basics json config. This section is intentionally kept narrow to provide a quick summary and prevent it from taking up too much real estate on the resume.

However, unfortunately it may be too narrow for folks with really long emails or website names. You can fix this in one of two ways:

1. You can simply add spaces in your JSON config to indicate line breaks to create multi-line styles. The example below will automatically put the @piedpiper.com into its own line

   "email": "richard.hendriks @piedpiper.com",
   

2. If you are only one or two characters away from fitting your long strings, you can adjust the width of the left column by going into variables.scss and adjusting the two following variables:

   $aside-width            : 160px;
   $aside-margin           : 20px;
   

   aside-width will determine how wide to keep the left column, and aside-margin will determine how much space you want to leave between the left column and the main content on the right.

Colors

I highly recommend this to give your resume its own personal flair, If you want to change the default color used within the theme with your own custom color, change the $primary-color variable within variable.scss with your own.

$primary-color          : $slate-green;

Developer Environment

The most important pieces of this environment are the two app and gulp folders as well as index.js. If you've already read through the jsonresume-theme-boilerplate, you should know what the files within /app and index.js represents.

/app

The app folder holds all of your assets. The file system should be straightforward to follow. All views will be under the /views folder. Most importantantly, this folder which contains resume.hbs, which is the main Handlebars template that will be used and sent to the theme server to render your resume. The /styles folder contains all of your SASS stylesheets.

/gulp

The gulp folder holds all the modularized gulp tasks/configs. Anything gulp related should go here. Please reference gulpfile.js as the source of truth.

index.js

This is the file that will return the HTML to the theme server and run against the resume-cli. Not much change here from the jsonresume-theme-boilerplate except that it has been modified to accomodate this file system.