PubNub ChatEngine is an object oriented event emitter based framework for building chat applications in Javascript. It reduces the time to build chat applications drastically and provides essential components like typing indicators, online presence monitoring and message history out of the box.
The real time server component is provided by PubNub. ChatEngine is designed to be extensible and includes a plugin framework to make adding new features simple.
Check out the getting started guide.
You can find the full docs on the full documentation website.
Check out the jQuery Kitchen Sink and Angular Kitchen Sink examples to see plugins in action.
- Typing Indicator
- Event Status and Read Receipts
- Mute Users
- Random Usernames
- Desktop Notifications
- Online User Search
- Image Uploads
- Persistent Message History
- Markdown Support
- Emoji Support
- Unread Messages
- Gravatar Support
The integration tests in test/integration includes some usage examples.
Clone repos (chat-engine and plugins).
All repos should be siblings of one another. This is required for rendering docs properly.
chat-engine
chat-engine-desktop-notifications
chat-engine-emoji
chat-engine-examples
//...
nvm use v6
run http-server from my /development directory which has all chat-engine repos:
cd chat-engine
node server.js
load http://localhost:8080 in browser and navigate to /chat-engine-examples/jquery/kitchen-sink
Run gulp to compile, but you should probably run gulp watch to get consistent changes.
Run gulp test.
npm version patch && git push origin master --tags