The whir.io chat server.
Switch branches/tags
Clone or download
Latest commit a7ee39c May 4, 2018

README.md

πŸ‘πŸ» 😎 πŸš€ 😻

whir.io

Β 

Alpha ES7 codebeat badge Codacy Badge Dependency status

Installation

  • Clone this repository (navigate to its location),
  • copy the .env.example to .env and fill the required values,
  • install what's needed: npm i,
  • run the application: npm run local

Whir should now be running on the specified port.

You can also start whir with npm start. In this case, however, you will need to export the right environment variables. (Same as defined in .env)

Take it for a spin

Deploy

Start chatting as soon as your Heroku instance is deployed:

  • Get the whir client: npm i -g whir.io,
  • connect to your server: whir.io -u [username] -h [your Heroku URL],
  • enjoy!

Notes

As you may have noticed, whir does not implement an actual HTTPS server, this is because whir was mainly written to run on Heroku and Heroku's SSL termination occurs at its load balancers; thus the application remains a non-HTTPS server.

Visit http://whir.io for more information.

Contribute

fork https://github.com/WhirIO/Server

License

MIT