webcv v1.0.3

webcv

A basic npm module to add a CV to your node.js web site and edit it online. Built using MEAN stack.

Screenshots

Requirements

• Node.js
• ExpressJS
• MongoDB

Installation

Just install webcv using npm:

npm install webcv --save

Execution

webcv(app, [opt])

Parameters

• app - ExpressJS handler.
• opt - Options (optional)
• {string} url - Route to access CV (default 'cv').
• {string} filename - JSON file with CV contents (default 'webcv.json').
• {boolean} listen - Whether or not execure ExpressJS listen (default false).
• {int} port - Port to listen to (default 3000).

Example usage

Create an app.js file, add requires for express and webcv and create the express handler:

var express = require('express');
var webcv = require('webcv');

var app = express();

Create an object with your customize options and call the webcv constructor:

opt = {listen: true, port: 8080, filename: 'cv.json', url: 'cv'};
webcv(app, opt);

From shell, create data folder in your project root and execute MongoDB daemon:

mkdir data
mongod --dbpath data/

Execute script in a different terminal:

node app.js

Access your CV from localhost/cv and edit it or load JSON from localhost/cv/#/edit. Prior to load CV from JSON, place the JSON file in the project root following the example format.

License

Copyright © 2016 Marco Vidal García marcovidal67@gmail.com

This work is free. You can redistribute it and/or modify it under the terms of the MIT License. See LICENSE for full details.