CleverStack/clever-odm

View on GitHub
README.md

Summary

Maintainability
Test Coverage
CleverStack ODM Module
====================
[![NPM version](https://badge.fury.io/js/clever-odm.png)](http://badge.fury.io/js/clever-odm) [![GitHub version](https://badge.fury.io/gh/cleverstack%2Fclever-odm.png)](http://badge.fury.io/gh/cleverstack%2Fclever-odm) [![Dependency Status](https://david-dm.org/CleverStack/clever-odm.png)](https://david-dm.org/CleverStack/clever-odm) [![devDependency Status](https://david-dm.org/CleverStack/clever-odm/dev-status.png)](https://david-dm.org/CleverStack/clever-odm#info=devDependencies) [![Code Climate](https://codeclimate.com/github/CleverStack/clever-odm.png)](https://codeclimate.com/github/CleverStack/clever-odm) 
[![Build Status](https://secure.travis-ci.org/CleverStack/clever-odm.png?branch=master)](https://travis-ci.org/CleverStack/clever-odm) 
[![Coverage](https://codeclimate.com/github/CleverStack/clever-odm/coverage.png)](https://codeclimate.com/github/CleverStack/clever-odm) [![NPM downloads](http://img.shields.io/npm/dm/clever-odm.png)](https://www.npmjs.org/package/clever-odm) 
[![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/) 

![CleverStack NodeJS ODM Module](http://cleverstack.github.io/assets/img/logos/node-seed-logo-clean.png "CleverStack NodeJS ODM Module")
<blockquote>
This CleverStack Module deeply integrates MongooseJS into CleverStack, to provide an out of the box Object Document Mapper which is rich in features, widely used and accepted, well tested, mature and a reliable Enterprise Grade NoSQL (DB) Solution.
</blockquote>

## Documentation

See [cleverstack.io](http://cleverstack.io/documentation/#backend) for more detailed information on the Node seed or visit the [Getting Started Guide](http://cleverstack.io/getting-started/)

## Install 
1. From your project folder run `clever install clever-odm`

2. In the config file for your desired environment (ie. backend/config/local.json), update the clever-odm object with the details for your database.

3. From your project's `backend` folder.
The database tables for your modules should now be installed!

## License

See our [LICENSE](https://github.com/CleverStack/clever-odm/blob/master/LICENSE)