|
1 | | -# js-data-mongodb |
2 | | -MongoDB adapter for js-data http://www.js-data.io/docs/dsmongodbadapter |
| 1 | +<img src="https://raw.githubusercontent.com/js-data/js-data/master/js-data.png" alt="js-data logo" title="js-data" align="right" width="64" height="64" /> |
| 2 | + |
| 3 | +## js-data-mongodb [](http://badge.fury.io/js/js-data-mongodb) |
| 4 | + |
| 5 | +MongoDB adapter for [js-data](http://www.js-data.io/). |
| 6 | + |
| 7 | +## API Documentation |
| 8 | +[DSMongoDBAdapter](http://www.js-data.io/docs/dsmongodbadapter) |
| 9 | + |
| 10 | +## Project Status |
| 11 | + |
| 12 | +| Branch | Master | |
| 13 | +| ------ | ------ | |
| 14 | +| NPM | [](http://badge.fury.io/js/js-data-mongodb) | |
| 15 | +| Build Status | [](https://travis-ci.org/js-data/js-data-mongodb) | |
| 16 | +| Code Climate | [](https://codeclimate.com/github/js-data/js-data-mongodb) | |
| 17 | +| Dependency Status | [](https://gemnasium.com/js-data/js-data-mongodb) | |
| 18 | +| Coverage | [](https://coveralls.io/r/js-data/js-data-mongodb?branch=master) | |
| 19 | + |
| 20 | +## Quick Start |
| 21 | +`npm install --save js-data js-data-mongodb`. |
| 22 | + |
| 23 | +```js |
| 24 | +var JSData = require('js-data'); |
| 25 | +var DSMongoDBAdapter = require('js-data-mongodb'); |
| 26 | + |
| 27 | +var store = new JSData.DS(); |
| 28 | + |
| 29 | +store.registerAdapter('mongodb', adapter, { default: true }); |
| 30 | + |
| 31 | +// "store" will now use the MongoDB adapter for all async operations |
| 32 | +``` |
| 33 | + |
| 34 | +## Changelog |
| 35 | +[CHANGELOG.md](https://github.com/js-data/js-data-mongodb/blob/master/CHANGELOG.md) |
| 36 | + |
| 37 | +## Community |
| 38 | +- [Mailing List](https://groups.io/org/groupsio/jsdata) - Ask your questions! |
| 39 | +- [Issues](https://github.com/js-data/js-data-mongodb/issues) - Found a bug? Feature request? Submit an issue! |
| 40 | +- [GitHub](https://github.com/js-data/js-data-mongodb) - View the source code for js-data. |
| 41 | +- [Contributing Guide](https://github.com/js-data/js-data-mongodb/blob/master/CONTRIBUTING.md) |
| 42 | + |
| 43 | +## Contributing |
| 44 | + |
| 45 | +First, feel free to contact me with questions. [Mailing List](https://groups.io/org/groupsio/jsdata). [Issues](https://github.com/js-data/js-data-mongodb/issues). |
| 46 | + |
| 47 | +1. Contribute to the issue that is the reason you'll be developing in the first place |
| 48 | +1. Fork js-data-mongodb |
| 49 | +1. `git clone https://github.com/<you>/js-data-mongodb.git` |
| 50 | +1. `cd js-data-mongodb; npm install; bower install;` |
| 51 | +1. `grunt go` (builds and starts a watch) |
| 52 | +1. (in another terminal) `grunt karma:dev` (runs the tests) |
| 53 | +1. Write your code, including relevant documentation and tests |
| 54 | +1. Submit a PR and we'll review |
| 55 | + |
| 56 | +## License |
| 57 | + |
| 58 | +The MIT License (MIT) |
| 59 | + |
| 60 | +Copyright (c) 2014-2015 Jason Dobry |
| 61 | + |
| 62 | +Permission is hereby granted, free of charge, to any person obtaining a copy |
| 63 | +of this software and associated documentation files (the "Software"), to deal |
| 64 | +in the Software without restriction, including without limitation the rights |
| 65 | +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 66 | +copies of the Software, and to permit persons to whom the Software is |
| 67 | +furnished to do so, subject to the following conditions: |
| 68 | + |
| 69 | +The above copyright notice and this permission notice shall be included in all |
| 70 | +copies or substantial portions of the Software. |
| 71 | + |
| 72 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 73 | +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 74 | +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 75 | +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 76 | +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 77 | +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 78 | +SOFTWARE. |
0 commit comments