search

aeirola / slack-irc-client

Use Slack as your IRC client
88 stars 16 forks source link

Instructions for running locally #8

Open Arthaey opened 8 years ago

Arthaey commented 8 years ago

I've forked this project and would like to contribute (starting with adding optional SSL support via node-irc's "secure" option).

Per your TODO list, you intent to write up installation instructions. Could you at least give me an abbreviated version here? :)

aeirola commented 8 years ago

Hey, really happy to hear that you are interested in contributing. Always nice with other people around.

By installation instructions, I suppose you mean some instructions for setting up a development environment. Summary follows:

  1. Install node and npm.
  2. Fetch dependencies: npm install
  3. Run linter and tests: npm test
  4. Run server (with debug logging): npm start -- -vvt ${SLACK_TOKEN}

I guess I should write some proper developer documentation, now that there seems to be more than one of us :)

P.S. Regarding the SSL support, it is already supported by adding passing "secure": true in the server configuration. This isn't explicitly stated anywhere, but works since all the configuration parameters are passed directly to node-irc as options.