# webcv

> Add easily your CV to your web and edit it online

Latest version **1.0.3** (published 2016-05-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install webcv
pnpm add webcv
yarn add webcv
bun add webcv
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2016-05-11 |
| First published | 2016-05-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | yes |
| GitHub stars | 0 |
| Author | Marco Vidal García |
| Maintainers | mvidalgarcia |
| Keywords | web, CV, editor, MEAN, json, angular, mongodb, express, node |

## Links

- npm: https://www.npmjs.com/package/webcv
- Repository: https://github.com/mvidalgarcia/webcv
- Homepage: https://github.com/mvidalgarcia/webcv#readme
- Issues: https://github.com/mvidalgarcia/webcv/issues
- npm.io page: https://npm.io/package/webcv

## Dependencies (3)

- [express](https://npm.io/package/express.md) ^4.13.4
- [mongodb](https://npm.io/package/mongodb.md) ^2.1.18
- [body-parser](https://npm.io/package/body-parser.md) ^1.15.1

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.3 (latest) — 2016-05-11
- 1.0.2 — 2016-05-11
- 1.0.1 — 2016-05-10
- 1.0.0 — 2016-05-10
- 0.0.2 — 2016-05-10
- 0.0.1 — 2016-05-10

## README

# webcv
A basic npm module to add a CV to your node.js web site and edit it online.
Built using [MEAN](https://en.wikipedia.org/wiki/MEAN_(software_bundle)) stack.  
  
[![npm](https://img.shields.io/npm/v/webcv.svg?style=flat-square)](http://www.npmjs.org/webcv)

## Screenshots
<img src="https://raw.githubusercontent.com/mvidalgarcia/webcv/master/screenshots/1.png"/>
<hr>
<img src="https://raw.githubusercontent.com/mvidalgarcia/webcv/master/screenshots/2.png"/>

## Requirements
- Node.js
- ExpressJS
- MongoDB

## Installation

Just install `webcv` using npm:

```shell
npm install webcv --save
```

## Execution
```javascript
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:

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

var app = express();
```

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

```javascript

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:

```shell
mkdir data
mongod --dbpath data/
```

Execute script in a different terminal:
```shell
node app.js
```

Access your CV from [localhost/cv](http://localhost:8080/cv/) and edit it or load JSON from [localhost/cv/#/edit](http://localhost:8080/cv/#/edit). Prior to load CV from JSON, place the JSON file in the project root following the [example](https://github.com/mvidalgarcia/webcv/blob/master/webcv.json) 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](https://opensource.org/licenses/ISC).
See LICENSE for full details.

---
_Source: https://npm.io/package/webcv · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
