PonyChat's fork of Shout
Go to file
Mattias Erming 8bf438992a Merge pull request #356 from jancborchardt/development-setup
add development setup instructions, thanks @hennevogel, fix #355
2015-03-29 15:41:27 +02:00
client Adds configurable network form display 2015-03-22 15:58:28 +01:00
defaults Adds configurable network form display 2015-03-22 15:58:28 +01:00
src Prevent HTML injection through /topic!!!! 2015-01-21 19:04:01 -08:00
test add basic environment for unit testing with mocha 2014-11-17 22:14:28 +02:00
.gitignore Update gitignore 2014-10-05 01:19:05 -07:00
.travis.yml Fix Travis CI errors 2015-02-06 05:43:19 -08:00
CHANGELOG.md Bump version 2015-01-11 14:55:58 -08:00
Gruntfile.js Emit topic over socket 2014-10-10 22:05:25 +02:00
README.md add development setup instructions, thanks @hennevogel, fix #355 2015-02-06 13:49:35 +01:00
index.js Rename cli folder 2014-08-25 02:40:13 -07:00
package.json Fix Travis CI errors 2015-02-06 05:43:19 -08:00

README.md

Shout

Try the Demo

What is it?
Shout is a web IRC client that you host on your own server.

What features does it have?

  • Multiple user support
  • Stays connected even when you close the browser
  • Connect from multiple devices at once
  • Responsive layout — works well on your smartphone
  • .. and more!

Install

sudo npm install -g shout

Usage

When the install is complete, go ahead and run this in your terminal:

shout --help

For more information, read the documentation.

Development setup

To run the app from source, just clone the code and run this in your terminal:

npm install
grunt build
node index.js

License

Available under the MIT license.