Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 1.85 KB

README.md

File metadata and controls

59 lines (45 loc) · 1.85 KB

Chatty

Chatty is a chat server and client application.
Screenshot from client

It consist of a node.js server with an ArangoDB backend and a html5/javascript client.


Install

As a prerequisite you need to have node.js and git.

Then run some commands in your terminal.

git clone git://github.com/kaerus/chatty.git
cd chatty
make 
node chatty-server

After you have done that you should be able to access the chat-server.

Database

The database is optional but in order to run the server in Full-Feature-Mode(tm) you have to install ArangoDB.

Clone ArangoDB, compile and install:

git clone git://github.com/triaAGENS/ArangoDB.git
cd ArangoDB
./configure
make
sudo make install
/usr/local/sbin/arangod

For additional information please consult the arangodb project.

Configuration

The chatty.json configuration file should be simple and self explanatory.

Client

All client side resources are placed in the public directory.
Chat commands recognized:

  • /nick <your nick> : Set a nickname (defaults to AnonXXX). The nick is persisted in localstorage.
  • /clear : clears the messages (locally).
  • /history <user> | <count> | <offset> : Shows <count> number of lines history from <offset> for specified <user> (or all by default).

How to contribute

  • Send your contributions as pull requests
  • Write documentation on the project wiki
  • Repost bugs, feature requests & suggestions as issues