2014-08-02 08:13:58 -04:00
|
|
|
# Shout [](https://www.npmjs.org/package/shout)
|
2014-07-20 19:14:36 -04:00
|
|
|
|
2014-10-01 15:10:14 -04:00
|
|
|
### [Try the Demo](http://demo.shout-irc.com/)
|
|
|
|
|
|
2014-08-18 08:50:12 -04:00
|
|
|
__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
|
2014-08-18 08:55:27 -04:00
|
|
|
- _.. and more!_
|
2014-08-18 08:50:12 -04:00
|
|
|
|
2014-07-20 19:14:36 -04:00
|
|
|
## Install
|
|
|
|
|
|
2014-08-12 21:27:53 -04:00
|
|
|
```
|
|
|
|
|
sudo npm install -g shout
|
|
|
|
|
```
|
2014-07-20 19:14:36 -04:00
|
|
|
|
2014-08-12 21:27:53 -04:00
|
|
|
## Usage
|
2014-07-20 19:14:36 -04:00
|
|
|
|
2014-09-30 14:18:31 -04:00
|
|
|
When the install is complete, go ahead and run this in your terminal:
|
2014-08-18 21:53:17 -04:00
|
|
|
|
2014-08-17 11:40:28 -04:00
|
|
|
```
|
|
|
|
|
shout --help
|
2014-08-12 21:27:53 -04:00
|
|
|
```
|
2014-07-20 19:14:36 -04:00
|
|
|
|
2014-09-30 14:21:03 -04:00
|
|
|
For more information, read the [documentation](http://shout-irc.com/docs/).
|
|
|
|
|
|
2015-02-06 06:10:11 -05:00
|
|
|
## Development setup
|
|
|
|
|
|
|
|
|
|
To run the app from source, just clone the code and run this in your terminal:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
npm install
|
2015-03-29 09:42:16 -04:00
|
|
|
grunt
|
|
|
|
|
./index.js --port 8080
|
2015-02-06 06:10:11 -05:00
|
|
|
```
|
|
|
|
|
|
2015-03-29 09:43:58 -04:00
|
|
|
And if you don't have [grunt](http://gruntjs.com/getting-started) installed already, just run `npm install -g grunt-cli`.
|
|
|
|
|
|
2014-07-20 19:14:36 -04:00
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
Available under [the MIT license](http://mths.be/mit).
|
