ChatEngine is a Rails 3 Engine created to give web applications an easy to use chat system.
The aim of this project is to make adding a chat engine to a Rails application quick and easy.
The ChatEngine uses Mongoid for the
Message domain model. Messages sent can include Markdown markup tags which are converted to HTML. The engine has been tested to work with Mongoid 3 and Rails 3.2+.
Usage example config
See the spec/dummy app for an example usage configuration (but without the pusher config). If you set the pusher config in the dummy app, you should be able to run the integration spec.
In hosting app Gemfile
bundle it from command line ;)
rails g chat_engine:install
To copy initializer to
Rails Asset pipeline
Assets are made available from
//= require chat-engine //= require jquery.cssemoticons.min //= require showdown
*= jquery.cssemoticons *= screen
Without Rails Asset pipeline
public assets to
public folder of your hosting app.
rails g chat_engine:assets
ChatEngine uses pusher to handle asychronous messaging. We have added a the necessary initializer for you to easily setup Pusher.
Locate chat_engine.rb in your initializer folder and change the following to your Pusher credentials.
Pusher.app_id = 'APP ID' Pusher.key = 'KEY' Pusher.secret = 'PASS'
You are now ready to go!
- Users able to select colours for their messages
- Asynchronous chat messaging
- Guest users able to add comments
- Chat modules can be stacked to enhance the chats functionality
- Easy to use admin panel for managing chat functionality
- Easy to use admin panel for managing features available to users
- Manage multiple chatrooms
This project rocks and uses MIT-LICENSE.