https://github.com/doorkeeper-gem/doorkeeper-mongodb
Mongoid and MongoMapper support for Doorkeeper.
https://github.com/doorkeeper-gem/doorkeeper-mongodb
doorkeeper doorkeeper-mongodb mongoid mongomapper
Last synced: about 1 year ago
JSON representation
Mongoid and MongoMapper support for Doorkeeper.
- Host: GitHub
- URL: https://github.com/doorkeeper-gem/doorkeeper-mongodb
- Owner: doorkeeper-gem
- License: mit
- Created: 2014-09-07T03:53:34.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2024-03-27T08:54:05.000Z (about 2 years ago)
- Last Synced: 2024-04-13T20:38:58.657Z (about 2 years ago)
- Topics: doorkeeper, doorkeeper-mongodb, mongoid, mongomapper
- Language: Ruby
- Homepage:
- Size: 241 KB
- Stars: 29
- Watchers: 4
- Forks: 50
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: MIT-LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Doorkeeper MongoDB extension
[](https://badge.fury.io/rb/doorkeeper-mongodb)
[](https://travis-ci.org/doorkeeper-gem/doorkeeper-mongodb)
## Documentation
This documentation is valid for `master` branch. Please check the documentation for the version
of doorkeeper-mongodb you are using in: https://github.com/doorkeeper-gem/doorkeeper-mongodb/releases.
## Installation
`doorkeeper-mongodb` provides [Doorkeeper](https://github.com/doorkeeper-gem/doorkeeper) support
for [Mongoid](https://github.com/mongodb/mongoid) versions 6 and later. Earlier versions of Mongoid
are supported on earlier versions of `doorkeeper-mongodb`.
To start using it, add both `doorkeeper` and `doorkeeper-mongodb` to your Gemfile:
```ruby
gem 'doorkeeper'
gem 'doorkeeper-mongodb'
# or if you want to use cutting edge version:
# gem 'doorkeeper-mongodb', github: 'doorkeeper-gem/doorkeeper-mongodb'
```
Run [doorkeeper’s installation generator]:
```bash
$ rails generate doorkeeper:install
```
[doorkeeper’s installation generator]: https://github.com/doorkeeper-gem/doorkeeper#installation
This will install the doorkeeper initializer into
`config/initializers/doorkeeper.rb`.
Set the ORM configuration:
```ruby
Doorkeeper.configure do
orm :mongoid8 # or any other version of mongoid
end
```
## Indexes
Make sure you create indexes for doorkeeper models. You can do this either by
running `rake db:mongoid:create_indexes` or (if you're using Mongoid 2) by
adding `autocreate_indexes: true` to your `config/mongoid.yml`
## Tests
To run tests, clone this repository and run `rake`. It will copy and run
doorkeeper’s original test suite, after configuring the ORM according to the
variables defined in `.travis.yml` file.
To run locally, you need to choose a gemfile, with a command similar to:
```bash
$ export RAILS=6.0
$ export BUNDLE_GEMFILE=$PWD/gemfiles/Gemfile.mongoid7.rb
```
---
Please refer to https://github.com/doorkeeper-gem/doorkeeper for instructions on
doorkeeper’s project.