Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gtomitsuka/montreus-chat

Montreus Chat - A Node.js + Socket.IO Chat, supporting Markdown and commands!
https://github.com/gtomitsuka/montreus-chat

chat socket-io

Last synced: 2 months ago
JSON representation

Montreus Chat - A Node.js + Socket.IO Chat, supporting Markdown and commands!

Awesome Lists containing this project

README

        

# montreus-chat
![Travis Build](https://travis-ci.org/gtomitsuka/montreus-chat.svg?branch=feature%2Fopen-sans)

Montreus Chat, as you can find on http://chat.oratio.io/room/900.

It's based on Node.js + Express.js + Socket.IO, and supports *Markdown*.
It includes tons of security: Protection against XSS scripting, against huge messages and thousands of robot connections that could take the server down.

Database-less edition available on the `no-db` branch.

## Installation Guide

1. Clone the repo using `git clone https://github.com/gtomitsuka/montreus-chat.git`.
1. Rename the `sample-config.json` to `config.json` and change it's config, if necessary.
1. Rename the `sample-room.json` to `room.json` and create your own rooms!
1. Run the `npm install` command on the repo's folder.
1. And for starting the instance run `node .`. You should use the Forever or PM2 modules for deamonzing the chat.

## Commands
These are the available Montreus Chat commands as of v2.7.x:

/help
/bot-say
/broadcast
/me