Giter Club home page Giter Club logo

jsonresume-boilerplate's Introduction

jsonresume-boilerplate

A boilerplate for developing JSONResume themes.

Usage

To start, copy the files of this folder into a folder named "jsonresume-theme-name", where the name is your desired theme name. Open up the package.json, and change the name to your desired theme name, as long as it starts with jsonresume-theme-. Use cd to get into this folder and run npm install to install the necessary node_modules for compilation.

Now, run node server.js and it will start your theme in localhost://8080. You will see a blank page with the title "Richard Hendriks", as your webpage is receiving data from the resumeSchema object, where a sample resume.json is located.

Now, open up your resume.template, and add in the <h1>{{bio.firstName}} {{bio.lastName}}</h1>. Save, and refresh localhost://8080. You will see an <h1> with the words "Richard Hendriks" on the screen.

In case you haven't noticed, we are using Mustache for our theme. You can use ERB, or other templating systems if you like, as long as it is able to return HTML from the resume.json object.

You can even dive right into the index.js file to add properties to the object dynamically (such as month or year from the date).

Publishing

If you already have an npm account, you could just go ahead and type npm publish and be done with it. You could update it like any other Node Package; constantly change the package.json version and run npm publish again.

If however, you are not familiar with NPM, take a look at their docs.

When your JSONResume Theme is published, you can easily view at http://themes.jsonresume.org/theme/themename, where themename is your theme name. Anyone will be able to use it now.

Closing Remarks

If you have any questions about theme development feel free to ask the JSONResume team, or possibly submit an issue here.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.