Added README file

master
Jesús Espino 2015-04-06 11:53:57 +02:00
parent 1f996be995
commit 632bace1e3
1 changed files with 40 additions and 0 deletions

40
README.md Normal file
View File

@ -0,0 +1,40 @@
Taiga events
============
![Kaleidos Project](http://kaleidos.net/static/img/badge.png "Kaleidos Project")
[![Managed with Taiga.io](https://taiga.io/media/support/attachments/article-22/banner-gh.png)](https://taiga.io "Managed with Taiga.io")
The Taiga websocket server.
Installation
------------
Install the RabbitMQ service.
```bash
apt-get install rabbitmq-server
```
Install the javascript dependencies.
```bash
npm install
```
Install globally the coffeescript interpreter.
```bash
sudo npm install -g coffee-script
```
Copy and edit the config.json file.
```bash
cp config.example.json config.json
```
Then run the taiga events service
```bash
coffee index.coffee
```