https://github.com/sneas/cv-template

Manage your CV as a web app (HTML, JS, CSS). Automatically generate HTML and PDF versions and deploy them on GitHub Pages on every push.
https://github.com/sneas/cv-template

curriculum-vitae curriculum-vitae-template cv cv-template gh-pages github-page html pdf pdf-versions resume resume-template template

Last synced: 29 days ago
JSON representation

Manage your CV as a web app (HTML, JS, CSS). Automatically generate HTML and PDF versions and deploy them on GitHub Pages on every push.

• Host: GitHub
• URL: https://github.com/sneas/cv-template
• Owner: sneas
• Created: 2017-11-10T18:47:32.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-06-19T16:54:00.000Z (6 months ago)
• Last Synced: 2024-11-13T06:03:12.812Z (29 days ago)
• Topics: curriculum-vitae, curriculum-vitae-template, cv, cv-template, gh-pages, github-page, html, pdf, pdf-versions, resume, resume-template, template
• Language: JavaScript
• Homepage: http://sneas.github.io/cv-template
• Size: 1.16 MB
• Stars: 142
• Watchers: 7
• Forks: 48
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• project-awesome - sneas/cv-template - Manage your CV as a web app (HTML, JS, CSS). Automatically generate HTML and PDF versions and deploy them on GitHub Pages on every push. (JavaScript)

README

        
# The Curriculum Vitae Template

You are a fantastic developer. Keep your CV on GitHub, exploiting Node.js GitHub action. Host it on GitHub Pages. Have both HTML and PDF versions automatically generated and consistent.

    

    

    

    

 

## What does this project do?

* Helps you to manage your CV as a web app (HTML + CSS + JS).

* Automatically generates and publishes HTML and PDF version on every push to `main`.

Demo: [http://sneas.github.io/cv-template](http://sneas.github.io/cv-template).

Real world example: [http://sneas.github.io/cv](http://sneas.github.io/cv).

## Motivation

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

The idea behind **The Curriculum Vitae Template** is to provide anyone with a quick solution for creating and managing CVs (both HTML and PDF versions) with the help of GitHub.

## Installation

1. Create a new repo out of this template by clicking [this link](https://github.com/sneas/cv-template/generate).

1. Clone the newly created repo.

1. Install project dependencies with `npm install`.

1. Run `npm run deploy` to initialize `gh-pages`. This is a one time action. Further deployments will be initiated by GitHub Actions on every push to `main`.

## Usage

1. Start local development server with `npm start`.

1. Update contents of `src` folder to fit your needs. This item is explained [below](#update-contents).

1. Commit and push your changes.

1. GitHub Actions will automatically build the latest version and deploy it to GitHub Pages.

1. Open `http://your-username.github.io/your-cv-repo`.

### Update contents

The project uses [HandlebarsJS](https://github.com/wycats/handlebars.js/) as a template engine.

The main HTML template is located in [src/templates/index.html](src/templates/index.html). Metadata for the template could be found in [src/metadata/metadata.js](src/metadata/metadata.js).

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