@leisurelink/mongorepo

mongorepo

A simple repository over MongoDB collections

Installation

Clone this repository, then use npm to install the dependencies:

npm install

Use

Reference the MongoRepo base class using node's require:

var MongoRepo = require('mongorepo');

See the examples for more.

Tests

Tests are written using Mocha and expect.js.

npm test

... or ...

mocha -R spec

Required Local Configuration For Tests To Succeed

The tests assume there is a MongoDB instance running on the default mongo port 27017.

The tests consult the environment variable MONGOHOST before connecting to MongoDB. If there is no environment variable, it uses localhost. You can indicate the remote mongo location on the command line (bash):

# Use the appropriate IP,
#   a Dockerized MongoDB would be located at the below
#   address on a Windows or a Mac OS X machine:
MONGOHOST=192.168.59.103 npm test

Easy Local MongoDB Setup using Docker

If you don't have mongodb installed we recommend installing Docker which enables you to quickly launch and run virtualized containers on your local machine [Windows Install Instructions].

Once you've got Docker on your system the following command will run mongodb in a container and map the default port to your localhost:

docker run -d -p 27017:27017 --name mongodb dockerfile/mongodb

Once you've run the mongodb docker container once, you can start and stop it from the command line:

docker stop mongodb

docker start mongodb

Additional Documentation

There is a document tree under the docs folder, its a work in progress.

Docs are built from source code comments using jsdoc.

If you'll be (re)building the docs, install jsdoc globally on your machine:

npm install -g jsdoc

The Makefile in the package's root directory contains a docs target.

make docs

Releases

2014-12-09 0.1.2 Fixes bug in #batchCreate