Merge pull request #1 from salomonelli/master

"Git Pull" from salomonelli/best-resume-ever

.travis.yml

@@ -1,22 +1,16 @@
-sudo: required
-
-dist: trusty
-
 language: node_js
+os:
+  - linux
+node_js:
+  - "8"
 
-node_js: stable
-
-cache:
-  directories:
-    - node_modules
-
-before_deploy:
-  - npm run build
-
-deploy:
-  provider: pages
-  skip_cleanup: true
-  github_token: $GITHUB_TOKEN
-  local_dir: dist
-  on:
-    branch: master
+before_install:
+  - export CHROME_BIN=chromium-browser
+  - export DISPLAY=:99.0
+  - sh -e /etc/init.d/xvfb start
+script:
+  - npm i --silent
+  - npm run lint
+  - npm run test:export
+  - npm run test:docs
+  - npm run test:e2e

DEVELOPER.md

@@ -31,6 +31,22 @@ Your new resume will be now reachable at localhost:8080/#/resume/TEMPLATE-NAME.
 <br>
 <br>
 
+5. Export resumes as PDF with `npm run export`. Verify export of new template.
+
+4. Generate previews by converting PDF-files to PNG-files with `npm run preview`.
+
+5. Add preview to `/src/pages/home.vue`:
+```javascript
+<div class="preview">
+  <router-link v-bind:to="'/resume/TEMPLATE-NAME'">
+    <div class="preview-wrapper">
+      <img src="../assets/preview/TEMPLATE-NAME.png" />
+      <span>left-right</span>
+    </div>
+  </router-link>
+</div>
+```
+
 ## Fonts
 
 ### Icons
@@ -59,7 +75,7 @@ All fonts are installed via npm. To add a new font, search for the associated np
 
 ## Export
 
-Resumes are being exported with [Electroshot](https://github.com/mixu/electroshot).
+Resumes are being exported with [Puppeteer](https://github.com/GoogleChrome/puppeteer).
 
 ### Box Shadows
 

README.md

@@ -7,6 +7,12 @@
   <br>
 </h1>
 
+<div align="center">
+
+[![Greenkeeper badge](https://badges.greenkeeper.io/salomonelli/best-resume-ever.svg)](https://greenkeeper.io/) [![Travis badge](https://travis-ci.org/salomonelli/best-resume-ever.svg?branch=master)](https://travis-ci.org/salomonelli/best-resume-ever)
+
+</div>
+
 <h4 align="center">
   :necktie: :briefcase: Build fast :rocket: and easy multiple beautiful resumes and create your best CV ever!
   <br><br>
@@ -18,6 +24,8 @@
 
 <p align="left">
 <img src="src/assets/preview/resume-purple.png" width="150" style="margin-right:5px; border: 1px solid #ccc;" />
+<img src="src/assets/preview/resume-side-bar-rtl.png" width="150" style="margin-right:5px; border: 1px solid #ccc;" />
+<img src="src/assets/preview/resume-left-right-rtl.png" width="150" style="margin-right:5px; border: 1px solid #ccc;" />
 <img src="src/assets/preview/resume-material-dark.png" width="150" style="margin-right:5px; border: 1px solid #ccc;" />
 <img src="src/assets/preview/resume-left-right.png" width="150" style="margin-right:5px; border: 1px solid #ccc;" />
 <img src="src/assets/preview/resume-side-bar.png" width="150" style="margin-right:5px; border: 1px solid #ccc;" />
@@ -29,21 +37,20 @@
 
 ## How to use
 
-best-resume-ever requires at least node v.8.5.
+best-resume-ever requires at least node v.8.5.0.
 
 1. Clone this repository.
 
 2. Run `npm install`.
 
-3. Edit your personal data in `src/person.js`.
+3. Customize your resume in the `resume/` directory: edit your data `data.yml` and replace your profile-picture `id.jpg`.
 
-4. Replace your profile-picture in `src/assets/person.jpg`.
+4. Preview resumes with `npm run dev`.
 
-5. Preview resumes with `npm run dev`.
+5. Export with `npm run export`.
 
-6. Export with `npm run export`.
 
-All resumes will be exported to `/pdf`.
+All resumes will be exported to the `pdf/` folder.
 
 <br>
 
@@ -57,7 +64,7 @@ Please read the <a href="DEVELOPER.md">developer docs</a> on how to create or up
 
 ## Contribute
 
-Feel free to add your own templates, language supports, fix bugs or improve the docs. Any kind of help is appreciated! If you any kind of changes to an existing template, please commit them as new templates.
+Feel free to add your own templates, language supports, fix bugs or improve the docs. Any kind of help is appreciated! If you make any kind of changes to an existing template, please commit them as new templates.
 
 <br>
 
@@ -67,8 +74,8 @@ Feel free to add your own templates, language supports, fix bugs or improve the
 This project uses several open source packages:
 
 * <a href="https://github.com/vuejs/vue" target="_blank">Vue</a>
+* <a href="https://github.com/GoogleChrome/puppeteer" target="_blank">Puppeteer</a>
 * <a href="https://github.com/less/less.js" target="_blank">LESS</a>
-* <a href="https://github.com/mixu/electroshot" target="_blank">Electroshot</a>
 
 <br>
 

build/build.js

@@ -1,5 +1,3 @@
-require('./check-versions')()
-
 process.env.NODE_ENV = 'production'
 
 var ora = require('ora')

build/check-versions.js

@@ -1,48 +0,0 @@
-var chalk = require('chalk')
-var semver = require('semver')
-var packageConfig = require('../package.json')
-var shell = require('shelljs')
-function exec (cmd) {
-  return require('child_process').execSync(cmd).toString().trim()
-}
-
-var versionRequirements = [
-  {
-    name: 'node',
-    currentVersion: semver.clean(process.version),
-    versionRequirement: packageConfig.engines.node
-  },
-]
-
-if (shell.which('npm')) {
-  versionRequirements.push({
-    name: 'npm',
-    currentVersion: exec('npm --version'),
-    versionRequirement: packageConfig.engines.npm
-  })
-}
-
-module.exports = function () {
-  var warnings = []
-  for (var i = 0; i < versionRequirements.length; i++) {
-    var mod = versionRequirements[i]
-    if (!semver.satisfies(mod.currentVersion, mod.versionRequirement)) {
-      warnings.push(mod.name + ': ' +
-        chalk.red(mod.currentVersion) + ' should be ' +
-        chalk.green(mod.versionRequirement)
-      )
-    }
-  }
-
-  if (warnings.length) {
-    console.log('')
-    console.log(chalk.yellow('To use this template, you must update following to modules:'))
-    console.log()
-    for (var i = 0; i < warnings.length; i++) {
-      var warning = warnings[i]
-      console.log('  ' + warning)
-    }
-    console.log()
-    process.exit(1)
-  }
-}

build/dev-server.js

@@ -1,5 +1,3 @@
-require('./check-versions')()
-
 var config = require('../config')
 if (!process.env.NODE_ENV) {
   process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV)

config/index.js

@@ -4,8 +4,8 @@ var path = require('path')
 module.exports = {
   build: {
     env: require('./prod.env'),
-    index: path.resolve(__dirname, '../dist/index.html'),
-    assetsRoot: path.resolve(__dirname, '../dist'),
+    index: path.resolve(__dirname, '../docs/index.html'),
+    assetsRoot: path.resolve(__dirname, '../docs'),
     assetsSubDirectory: 'static',
     assetsPublicPath: '/best-resume-ever/',
     productionSourceMap: true,

docs/index.html

@@ -0,0 +1 @@
+<!DOCTYPE html><html><head><meta charset=utf-8><title>best-resume-ever</title><link href=/best-resume-ever/static/css/app.93b0b43de44566e679cbcb1192e60799.css rel=stylesheet></head><body><div id=app></div><script type=text/javascript src=/best-resume-ever/static/js/manifest.9e85fafdfbbcf91af5e7.js></script><script type=text/javascript src=/best-resume-ever/static/js/vendor.651023c261ca8937f2d6.js></script><script type=text/javascript src=/best-resume-ever/static/js/app.e2c878cafbb20641fa24.js></script></body></html>