Skip to content
Snippets Groups Projects
README.md 3.88 KiB
Newer Older
Gabriel Engel's avatar
Gabriel Engel committed
<img src="http://rocket.chat/images/logo/logo-dark.svg" />

The Complete Open Source Chat Solution

## Demo

Checkout the latest version at http://rocket.chat

## About

Gabriel Engel's avatar
Gabriel Engel committed
[![Code Climate](https://codeclimate.com/github/RocketChat/Rocket.Chat/badges/gpa.svg)](https://codeclimate.com/github/RocketChat/Rocket.Chat)

Henry Hsiao's avatar
Henry Hsiao committed
Rocket.Chat is a Web Chat Server, developed in JavaScript, using the [Meteor](https://www.meteor.com/install) fullstack framework.
Gabriel Engel's avatar
Gabriel Engel committed

It is a great solution for communities and companies wanting to privately host their own chat service or for developers looking forward to build and evolve their own chat platforms.

Gabriel Engel's avatar
Gabriel Engel committed
### On the News
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
##### [Hacker News](https://news.ycombinator.com/item?id=9624737)
> Yes, we made it to the #1
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
##### [Product Hunt](http://www.producthunt.com/posts/rocket-chat)
> Your own open source Slack-like chat
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
##### [JavaScript Weekly](http://javascriptweekly.com/issues/234)
> An open source Web based, channel based chat system (a la Slack) built using Meteor, the full stack JavaScript development platform.
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
##### [wwwhatsnew.com](http://wwwhatsnew.com/2015/05/30/rocket-chat-para-los-programadores-que-quieran-ofrecer-un-chat-en-su-web/)
> Para los programadores que quieran ofrecer un chat en su web
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
##### [clasesdeperiodismo.com](http://www.clasesdeperiodismo.com/2015/05/30/un-chat-de-codigo-abierto-que-puedes-anadir-a-la-web/)
> Un chat de código abierto que puedes añadir a la web
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
## Installation

### Development

Gabriel Engel's avatar
Gabriel Engel committed
Prerequisites:

* [Git](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
* [Meteor](https://www.meteor.com/install)

Now just clone and start the app:

```sh
git clone https://github.com/RocketChat/Rocket.Chat.git
cd Rocket.Chat
meteor
```

### Production

#### One-Click Deploy
##### Heroku

[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)

## Current Features
Gabriel Engel's avatar
Gabriel Engel committed

- BYOS (bring your own server)
- Multiple Rooms
Gabriel Engel's avatar
Gabriel Engel committed
- Direct Messages
- Private Groups
- Public Channels
- Desktop Notifications
- Mentions
- Avatars
- Markdown
- Emojis
- Transcripts / History
- I18n - Internationalization

### Roadmap for v1.0

- Image embeds
- File uploads
- Full text search
- REST-like APIs
- Hubot Friendly
- Off-the-Record (OTR) Messaging
- LDAP / Kerberos Authentication
- XMPP Multi-user chat (MUC)
Gabriel Engel's avatar
Gabriel Engel committed
- WebRTC signalling
Gabriel Engel's avatar
Gabriel Engel committed
- Native Mobile App
- Native Desktop App
Gabriel Engel's avatar
Gabriel Engel committed

#### Changelog

Changelog can be found in the HISTORY.md file.

### Issues

[Github Issues](https://github.com/RocketChat/Rocket.Chat/issues) are used to track todos, bugs, feature requests, and more.

### Documentation

Checkout [Github Wiki](https://github.com/RocketChat/Rocket.Chat/wiki) (coming soon)

## Credits

Thanks to [Diego Sampaio](https://github.com/sampaiodiego), [Gabriel Engel](https://github.com/engelgabriel), [Marcelo Schmidt](https://github.com/marceloschmidt), [Rafael Caferati](https://github.com/rcaferati) e [Rodrigo Nascimento](https://github.com/rodrigok)

Gabriel Engel's avatar
Gabriel Engel committed
Emoji provided free by [Emoji One](http://emojione.com)

Performance monitoring provided by [Kadira](https://kadira.io/)
Gabriel Engel's avatar
Gabriel Engel committed

### Contributions

##### We Need Your Help!

Filipe Alvarenga's avatar
Filipe Alvarenga committed
A lot of work has already gone into Rocket.Chat, but we have much bigger plans for it!
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
So if you'd like to be part of the project, please check out the [roadmap](https://github.com/RocketChat/Rocket.Chat/milestones) and [issues](https://github.com/RocketChat/Rocket.Chat/issues) to see if there's anything you can help with.
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
### Translations

We are experimenting [transifex](https://www.transifex.com/organization/rocketchat/dashboard/rocketchat). If you want to help, try it out, let us know and please give us some feedback about the experience. 

Gabriel Engel's avatar
Gabriel Engel committed
### Community

Andy Grover's avatar
Andy Grover committed
Join the the converation at [Twitter](http://twitter.com/RocketChatApp), [Facebook](https://www.facebook.com/RocketChatApp) or [Google Plus](https://plus.google.com/+RocketChatApp)
Gabriel Engel's avatar
Gabriel Engel committed

### License

Note that Rocket.Chat is distributed under the [MIT License](http://opensource.org/licenses/MIT).