|
1 |
| -Kandan |
2 |
| -========= |
| 1 | +Kandan - Modern Open Source Chat |
| 2 | +================================ |
| 3 | +The slickest chat app out there. Open-source and well-supported to boot. |
3 | 4 |
|
4 |
| -A Bushido chat application |
| 5 | + |
5 | 6 |
|
| 7 | +Standard Features |
| 8 | +================= |
| 9 | +These are features that work out of the box on any provider: |
6 | 10 |
|
| 11 | + * Easy deploy to CloudFuji, CloudFoundry, Heroku, dotCloud, etc. |
| 12 | + * Collaborative team chat |
| 13 | + * Unlimited channels |
| 14 | + * Embed formats for images and youtube videos with requests for others (twitter, facebook, g+, etc.) |
| 15 | + * Synchronized sound player - play any audio-tag compatible url for the whole channel (Pending :P) |
| 16 | + * /me command! |
| 17 | + * Highly extensible plugin format |
| 18 | + |
| 19 | +CloudFuji Extended Features |
| 20 | +=========================== |
| 21 | +In addition to the standard features above, Kandan can take advantage of CloudFuji features when run on our cloud: |
| 22 | + |
| 23 | +* One-click deploy |
| 24 | +* Team-aware: Setup your team once, and have them in every CloudFuji app |
| 25 | +* Event-aware: Build widgets that display build status, customer signups, website status, and much more |
| 26 | + |
| 27 | +SHUT UP AND LET ME USE IT |
| 28 | +========================= |
| 29 | + |
| 30 | +## CloudFuji |
| 31 | +If you're part of the CloudFuji Beta you should already have access to Kandan with all the enhanced features from the app store. |
| 32 | + |
| 33 | +Just click launch on here https://bushi.do/apps/new?app=kandan; you and your team should be all setup. |
| 34 | + |
| 35 | +## Cloud Foundry |
| 36 | +Looking for community help here |
| 37 | + |
| 38 | +## Heroku |
| 39 | +The following should work reliably on Heroku: |
| 40 | + |
| 41 | + git clone https://github.com/Bushido/kandan.git |
| 42 | + cd kandan |
| 43 | + heroku create --stack cedar |
| 44 | + git push heroku master |
| 45 | + heroku run rake db:migrate kandan:bootstrap |
| 46 | + heroku open |
| 47 | + |
| 48 | + |
| 49 | +Your app should be up and running now. The admin email by default is `admin@kandan.me` with password `kandanadmin`, or you can sign up as another user. |
| 50 | + |
| 51 | +## dotCloud |
| 52 | +Looking for community help here. |
| 53 | + |
| 54 | +TODO |
| 55 | +==== |
| 56 | +See the issue tracker |
| 57 | + |
| 58 | +Get Involved! |
| 59 | +============= |
| 60 | +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. |
| 61 | + |
| 62 | +* Talk with us on the [mailing list])(https://groups.google.com/forum/?fromgroups#!forum/cloudfuji) |
| 63 | +* GitHub [issues tracker](https://github.com/Bushido/Kandan/issues) |
| 64 | +* Twitter [@cloudfuji](https://twitter.com/#!/cloudfuji) |
| 65 | +* [New-wave open-source meetup](www.meetup.com/San-Francisco-New-Wave-Open-Source-Apps/) - we meetup once a month to share tips on how developers grow business around super high-quality open source software |
| 66 | +* ... is there a fifth way? Telegram maybe? |
| 67 | + |
| 68 | +LICENSE |
| 69 | +======= |
| 70 | +Kandan's code and assets are dual-licensed. Kanda 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 [support@cloudfuji.com](mailto:support@cloudfuji.com) if you're interested in development of Kandan under a custom license. |
0 commit comments