https://github.com/amiel/chat-engine
A very lightweight chat room in the form of a rails engine using jQuery
https://github.com/amiel/chat-engine
Last synced: about 1 year ago
JSON representation
A very lightweight chat room in the form of a rails engine using jQuery
- Host: GitHub
- URL: https://github.com/amiel/chat-engine
- Owner: amiel
- Created: 2009-04-04T16:42:09.000Z (about 17 years ago)
- Default Branch: master
- Last Pushed: 2009-04-20T03:07:32.000Z (about 17 years ago)
- Last Synced: 2024-10-03T12:33:14.861Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 97.7 KB
- Stars: 4
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.textile
Awesome Lists containing this project
README
h1. Chat Engine
Chat Engine is a lightweight rails engine that heavily uses jQuery and memcached to implement a very simple group chat room.
h2. Status
Chat Engine has just been ported to rails 2.3, and its original design striped.
h2. Features
* You must enter a nickname to be part of the chat room.
* All logged in users are shown in the user list
* Lines in the chat that mention a users nickname are highlighted.
* Inactivity timer will logout users from the client side.
* rake task to logout users whose browsers do not allow ajax requests in the unload event.
* The ability to mute specific users (from script/console). Muted users will see their own messages, but no one else will.
h2. Usage
install chat-engine
./script/plugin install git://github.com/amiel/chat-engine.git
copy assets
rake chat:sync
include assets, don't forget jquery
<%= stylesheet_link_tag 'chat' %>
<%= javascript_include_tag 'jquery-x.x.x.js', 'auto_scroll', 'chat' %>
use the chat_overlay partial
<%= render :partial => 'chats/chat_overlay' %>
thats it! it will work with memory_store, but is not persistent across mongrels. User mem_cached_store for best results.
For an example, check out "http://github.com/amiel/chat-engine-example":http://github.com/amiel/chat-engine-example
h2. History
This chat was originally written for Tatango.TV (http//tatango.tv).