Skip to content
This repository has been archived by the owner on Jun 26, 2019. It is now read-only.
/ innbox Public archive

Mountable Private Messaging Engine for any Rails application.

License

Notifications You must be signed in to change notification settings

rails-engine/innbox

Repository files navigation

Innbox

Mountable Personal Messaging Engine for any Rails application.

Gem Version Build Status Code Climate codecov.io

Installation

Add this line to your application's Gemfile:

gem 'innbox'

And then execute:

$ bundle

Now you have the generators available in Rails application:

$ rails g innbox:install

You can also generate views and controller if you need to customize them:

$ rails g innbox:views
$ rails g innbox:controllers

Then mount it in routes.rb:

mount Innbox::Engine, at: "/innbox"

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/innbox. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.