emotionLoop/visualCaptcha-node

# visualCaptcha-node

[![Build Status](https://travis-ci.org/emotionLoop/visualCaptcha-node.svg?flat=true&branch=master)](https://travis-ci.org/emotionLoop/visualCaptcha-node)
[![Coverage Status](https://coveralls.io/repos/emotionLoop/visualCaptcha-node/badge.svg?flat=true)](https://coveralls.io/r/emotionLoop/visualCaptcha-node)
[![Codacy](https://www.codacy.com/project/badge/fd2763e38c584ec689c2617c112852e8)](https://www.codacy.com/app/bruno-bernardino/visualCaptcha-node)
[![Code Climate](https://codeclimate.com/github/emotionLoop/visualCaptcha-node/badges/gpa.svg)](https://codeclimate.com/github/emotionLoop/visualCaptcha-node)

Node.js sample for visualCaptcha.

A demo/sample Node.js app that uses the [visualcaptcha npm module](https://github.com/emotionLoop/visualCaptcha-npm) and the [visualcaptcha vanilla js bower package](https://github.com/emotionLoop/visualCaptcha-frontend-vanilla), as a proof-of-concept for how to integrate it with your Node.js project.


## Installation 

You need Node.js installed with npm.
```
npm install
```


## Run server

To start the server on port 8282 (default), run the following command:
```
npm start
```


## Run tests

If you want to run the unit tests, use the following command:
```
npm test
```


## API

visualCaptcha, since 5.0, uses an API for increased security and to become back-end-agnostic (that's why you can easily plug-in a Vanilla JS, AngularJS, or jQuery front-end without changing anything).

It expects the following routes to exist, which we've put in this sample, using Express (just to make it easier).

You are expected to have these routes in your implementation, but you can change them in visualCaptcha's front-end config.

### GET `/start/:howmany`

This route will be the first route called by the front-end, which will generate and store session data.

Parameters:

- `howmany` is required, the number of images to generate.

### GET `/image/:index`

This route will be called for each image, to get it and show it, by index.

Parameters:

- `index` is required, the index of the image you want to get.

### GET `/audio(/:type)`

This route will be called for the audio file, to get it and play it, either the mp3 or ogg file.

Parameters:

- `type` is optional, the audio file format defaults to `mp3`, but can also be `ogg`.

### POST `/try` 

This is just a sample route, where we post the form to, and where the visualCaptcha validation takes place.


## License

MIT. Check the LICENSE file.

## Coding guidelines / Code style

View [http://jscode.org/readable](http://jscode.org/readable)