kandanapp/kandan

View on GitHub
README.md

Summary

Maintainability
Test Coverage
Kandan - [Modern Open Source Chat](http://www.getkandan.com)
================================
[![Build Status](https://travis-ci.org/kandanapp/kandan.png?branch=master)](https://travis-ci.org/kandanapp/kandan)
[![Coverage Status](https://coveralls.io/repos/kandanapp/kandan/badge.png?branch=master)](https://coveralls.io/r/kandanapp/kandan)
[![Dependency Status](https://gemnasium.com/kandanapp/kandan.png)](https://gemnasium.com/kandanapp/kandan)
[![Code Climate](https://codeclimate.com/github/kandanapp/kandan.png)](https://codeclimate.com/github/kandanapp/kandan)

What is Kandan? Kandan is a private chat service for your company or team. You can invite colleagues to share ideas and files in a persistent group chat room or rooms.

Unlike HipChat or other alternatives, Kandan is completely Open Source and can be hosted internally or externally by your organization or by a third party.

![](https://raw.github.com/kandanapp/kandan/resources/kandan_1.1.png)

Standard Features
=================
These are features that work out of the box on any provider:

 * Easy deploy to CloudFoundry, Heroku, dotCloud, etc.
 * Collaborative team chat
 * Unlimited channels
 * Embed formats for images and youtube videos with requests for others (twitter, facebook, g+, etc.)
 * Synchronized sound player - play any audio-tag compatible url for the whole channel (Pending :P)
 * /me command!
 * Highly extensible plugin format
 * [Your very own robotic companion](https://github.com/kandanapp/hubot-kandan-app)

Deployment
==========

See [DEPLOY.md](https://github.com/kandanapp/kandan/blob/master/DEPLOY.md) for information on deploying.


TODO
====
We're tracking milestones and todo items in the tracker
[See the issue tracker](https://github.com/kandanapp/kandan/issues)

Get Involved!
=============
That's not a question, it's an order! Or more of a friendly offer, really. Kandan is a fully open-source app, so dive in and start adding features, fixing bugs (what bugs?), and cleaning up the code.

* GitHub [issues tracker](https://github.com/kandanapp/kandan/issues)
* Twitter [@kandanapp](https://twitter.com/kandanapp)
* [Kandan Demo](http://demo.getkandan.com) (Yes we eat our own DogFood)

You can also email us at [admin@getkandan.com](mailto:admin@getkandan.com)


Credits
=======
* [Sacha Greif](http://sachagreif.com/i-wrote-a-book/) for his __amazing__ design job and exacting implementation standards on Kandan. A wonder and a pleasure to work with.
* [Andrew Hampton](https://github.com/andrewhampton) For the initial manual server install instructions.
* [Akash Manohar J](https://github.com/HashNuke) For some of the initial work on Kandan
* [Thomas Risberg](https://github.com/trisberg) For the Cloud Foundry install instructions and compatibility fixes.
* and many other [amazing contributors](https://github.com/kandanapp/kandan/graphs/contributors) 

LICENSE
=======
Kandan's code and assets are dual-licensed. Kandan is available generally under the AGPL, and also under a custom license via special agreement. See LICENSE for the AGPL terms, and contact us at [admin@getkandan.com](mailto:admin@getkandan.com) if you're interested in development of Kandan under a custom license.