Home

Awesome

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?

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
npm run build
npm start

Running locally

Click the button bellow to quickly and safely install this project on your local machine.

Run project

The Run Project button employs azk, a lightweight open source orchestration tool that will automatically isolate and configure the application's environment for you.

Learn more about azk here.

Deploying to DigitalOcean

After you run this project locally using Run Project button, deploying to DigitalOcean is very simple.

First, be sure you have SSH keys configured in your machine. If you don't have it yet (or if you aren't sure about it), just follow steps 1 and 2 of this tutorial.

Next, put your personal access token into a .env file:

$ cd path/to/the/project
$ echo "DEPLOY_API_TOKEN=<YOUR-PERSONAL-ACCESS-TOKEN>" >> .env

Then, just run the following:

$ azk deploy

The Run Project button employs azk, a lightweight open source orchestration tool that will automatically isolate and configure the application's environment for you.

Find instructions for further resources (mostly customizations) to deploy to DigitalOcean using azk here.

License

Available under the MIT License.

Some fonts licensed under SIL OFL and the Apache License.