denim-monk-db-factory

Factory utility for configuring monk db across platform applications

Getting Started

yarn add denim-monk-db-factory

Prerequisites

None

Installing

Clone the repo

git clone https://github.com/denimlabs/denim-monk-db-factory.git

import

import { getMonkDb, makeDbOptions } from 'denim-monk-db-factory'

// DATABASE SETUP
const dbOptions = makeDbOptions(config.DB)
const db = getMonkDb(dbOptions)
//use db as a normal monk addapter

Running the tests

yarn test

Deployment

yarn publish

Built With

• node - Node 9.2.0
• babel-cli - Used for transpiling and running es6
• babel-preset-env - Used for transpiling and running es6
• jest - Testing framework
• chai - Assertion Library
• husky - Pre-commit hooks
• lint-staged - Linting for changed files
• monk - Light Mongo ORM
• fs - node file system module
• chalk - Colored console output

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Michael W. Clark - Initial work - MichaelWClark

License

This project is licensed under the MIT License - see the LICENSE.md file for details