Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"presets": [
"es2015"
],
"plugins": [
"syntax-async-functions",
"transform-regenerator"
]
}
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ bower_components/

rethinkdb_data/
doc/
.nyc_output/
.nyc_output/
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
##### 3.0.0 - 18 August 2017

Stable 3.0.0 release

##### 3.0.0-rc.3 - 17 October 2016

###### Bug fixes
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2014-2016 js-data-rethinkdb project authors
Copyright (c) 2014-2017 js-data-rethinkdb project authors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
108 changes: 68 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,43 +2,71 @@

# js-data-rethinkdb

[![Slack Status][sl_b]][sl_l]
[![npm version][npm_b]][npm_l]
[![Circle CI][circle_b]][circle_l]
[![npm downloads][dn_b]][dn_l]
[![Coverage Status][cov_b]][cov_l]

RethinkDB adapter for [js-data](http://www.js-data.io/).

To get started, visit __[http://js-data.io](http://www.js-data.io/docs/js-data-rethinkdb)__.

## Links

* [Quick start](http://www.js-data.io/docs/home#quick-start) - Get started in 5 minutes
* [Guides and Tutorials](http://www.js-data.io/docs/home) - Learn how to use JSData
* [`RethinkDBAdapter` Guide](http://www.js-data.io/docs/js-data-rethinkdb) - Learn how to use `RethinkDBAdapter`
* [API Reference Docs](http://api.js-data.io) - Explore components, methods, options, etc.
* [Community & Support](http://js-data.io/docs/community) - Find solutions and chat with the community
* [General Contributing Guide](http://js-data.io/docs/contributing) - Give back and move the project forward
* [Contributing to js-data-rethinkdb](https://github.com/js-data/js-data-rethinkdb/blob/master/.github/CONTRIBUTING.md)

## License

The MIT License (MIT)

Copyright (c) 2014-2016 js-data-rethinkdb project authors

* [LICENSE](https://github.com/js-data/js-data-rethinkdb/blob/master/LICENSE)
* [AUTHORS](https://github.com/js-data/js-data-rethinkdb/blob/master/AUTHORS)
* [CONTRIBUTORS](https://github.com/js-data/js-data-rethinkdb/blob/master/CONTRIBUTORS)

[sl_b]: http://slack.js-data.io/badge.svg
[sl_l]: http://slack.js-data.io
[npm_b]: https://img.shields.io/npm/v/js-data-rethinkdb.svg?style=flat
[npm_l]: https://www.npmjs.org/package/js-data-rethinkdb
[circle_b]: https://img.shields.io/circleci/project/js-data/js-data-rethinkdb.svg?style=flat
[circle_l]: https://circleci.com/gh/js-data/js-data-rethinkdb
[dn_b]: https://img.shields.io/npm/dm/js-data-rethinkdb.svg?style=flat
[dn_l]: https://www.npmjs.org/package/js-data-rethinkdb
[cov_b]: https://img.shields.io/codecov/c/github/js-data/js-data-rethinkdb.svg?style=flat
[cov_l]: https://codecov.io/github/js-data/js-data-rethinkdb
[![Slack][1]][2]
[![NPM][3]][4]
[![Tests][5]][6]
[![Downloads][7]][8]
[![Coverage][9]][10]

RethinkDB adapter for the [JSData Node.js ORM][11].

### Installation

npm install --save js-data js-data-rethinkdb

### Usage

```js
import { RethinkDBAdapter } from 'js-data-rethinkdb';

// Create an instance of RethinkDBAdapter
const adapter = new RethinkDBAdapter();

// Other JSData setup hidden

// Register the adapter instance
store.registerAdapter('rethinkdb', adapter, { default: true });
```

### JSData + RethinkDB Tutorial

Start with the [JSData + RethinkDB tutorial][12] or checkout the [API Reference Documentation][13].

### Need help?

Please [post a question][14] on Stack Overflow. **This is the preferred method.**

You can also chat with folks on the [Slack Channel][15]. If you end up getting
your question answered, please still consider consider posting your question to
Stack Overflow (then possibly answering it yourself). Thanks!

### Want to contribute?

Awesome! You can get started over at the [Contributing guide][16].

Thank you!

### License

[The MIT License (MIT)][17]

Copyright (c) 2014-2017 [js-data-rethinkdb project authors][18]

[1]: http://slack.js-data.io/badge.svg
[2]: http://slack.js-data.io
[3]: https://img.shields.io/npm/v/js-data-rethinkdb.svg?style=flat
[4]: https://www.npmjs.org/package/js-data-rethinkdb
[5]: https://img.shields.io/circleci/project/js-data/js-data-rethinkdb.svg?style=flat
[6]: https://circleci.com/gh/js-data/js-data-rethinkdb
[7]: https://img.shields.io/npm/dm/js-data-rethinkdb.svg?style=flat
[8]: https://www.npmjs.org/package/js-data-rethinkdb
[9]: https://img.shields.io/codecov/c/github/js-data/js-data-rethinkdb.svg?style=flat
[10]: https://codecov.io/github/js-data/js-data-rethinkdb
[11]: http://www.js-data.io/
[12]: http://www.js-data.io/docs/js-data-rethinkdb
[13]: http://api.js-data.io/js-data-rethinkdb
[14]: http://stackoverflow.com/questions/tagged/jsdata
[15]: http://slack.js-data.io/
[16]: https://github.com/js-data/js-data-rethinkdb/blob/master/.github/CONTRIBUTING.md
[17]: https://github.com/js-data/js-data-rethinkdb/blob/master/LICENSE
[18]: https://github.com/js-data/js-data-rethinkdb/blob/master/AUTHORS
18 changes: 13 additions & 5 deletions circle.yml
Original file line number Diff line number Diff line change
@@ -1,24 +1,32 @@
# Adjust the behavior of the virtual machine (VM)
machine:
node:
version: 6.11.2

# Use for broader build-related configuration
general:
branches:
ignore:
- gh-pages
machine:
node:
version: 5.7.0

dependencies:
pre:
- npm i -g npm
- npm i -g codecov nyc
- npm i js-data@^3.0.0-rc.4 rethinkdbdash
- source /etc/lsb-release && echo "deb http://download.rethinkdb.com/apt $DISTRIB_CODENAME main" | sudo tee /etc/apt/sources.list.d/rethinkdb.list
- wget -qO- http://download.rethinkdb.com/apt/pubkey.gpg | sudo apt-key add -
- sudo apt-get update -qq
- sudo apt-get install rethinkdb -y --force-yes
- sudo cp /etc/rethinkdb/default.conf.sample /etc/rethinkdb/instances.d/instance1.conf
- echo "cache-size=128" | sudo tee --append /etc/rethinkdb/instances.d/instance1.conf
- echo "no-http-admin" | sudo tee --append /etc/rethinkdb/instances.d/instance1.conf
- sudo /etc/init.d/rethinkdb restart
- sleep 5
post:
- sudo rethinkdb --io-threads 2048 --daemon
- ulimit -S -n 2048
- sleep 10
test:
post:
- nyc report --reporter=lcov | codecov
- nyc report --reporter=lcov > coverage.lcov && codecov
- sudo killall rethinkdb
2 changes: 1 addition & 1 deletion conf.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"templates": {
"theme": "jsdata",
"systemName": "js-data-rethinkdb",
"copyright": "js-data-rethinkdb Copyright © 2014-2016 js-data-rethinkdb project authors",
"copyright": "js-data-rethinkdb Copyright © 2014-2017 js-data-rethinkdb project authors",
"outputSourceFiles": true,
"linenums": true,
"footer": "<div style=\"text-align:center\"><a href=\"/\">api.js-data.io</a>&nbsp;&#8226;&nbsp;<a href=\"http://js-data.io\">js-data.io</a></div>",
Expand Down
Loading