Giter Club home page Giter Club logo

cv-project's Introduction

The Curriculum Vitae Project

You are an amazing developer. Keep your CV on GitHub. Host it on GitHub pages. Have both HTML and PDF versions automatically generated and consistent. This is what good developers do.

Demo: http://sneas.github.io/cv-project.

Real world example: http://sneas.github.io/cv.

Motivation

GitHub Pages is probably the best place developer could store it's CV. Giving a potential employer a link to your CV stored on GitHub shows your strong desire for automation and definitely stands you out.

The idea behind The Curriculum Vitae Project is to provide anyone a quick solution for managing CV (both HTML and PDF versions) with GitHub.

Installation

One step way (if you don't mind forking)

  1. Fork this repo

Multi step way (for those who who doesn't want to fork)

  1. Create and clone a new repo
  2. npm install -g git-cp
  3. cd into the repo's folder
  4. git-cp [email protected]:sneas/cv-project.git

Usage

  1. Install project dependencies with npm install
  2. Start local development server with npm start.
  3. Update contents of src folder to fit your needs. This item is explained below.
  4. Commit your changes.
  5. Publish your updated CV on GitHub pages with npm run gh.
  6. Open http://your-username.github.io/your-cv-repo
  7. Have a cookie ๐Ÿช

Update contents

The project uses HandlebarsJS as a template engine.

The main HTML template could be found in src/templates/index.html. Metadata for the template could be found in src/metadata/metadata.js.

Don't forget to update src/assets/favicon.ico. You can generate a new favicon out of your photo with icoconvert.com.

cv-project's People

Contributors

sneas avatar

Watchers

 avatar

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.