Go to file

Jan-Stefan Janetzky d5585fa38f fixed a linebreak in readme		2018-03-15 16:05:50 +00:00
.config.example.json	invalidated all passwords and copied them to a local config file	2018-03-15 15:05:46 +00:00
.gitignore	invalidated all passwords and copied them to a local config file	2018-03-15 15:05:46 +00:00
.nvmrc	added systemd unit file, updated dependencies, pinned node release version	2018-03-15 14:14:13 +00:00
boot.sh	derps	2017-03-17 16:55:31 +01:00
chatCommands.js	adding additional haskell triggers	2017-03-24 11:42:34 +01:00
index.js	invalidated all passwords and copied them to a local config file	2018-03-15 15:05:46 +00:00
package-lock.json	updated package.json	2018-03-15 15:24:59 +00:00
package.json	updated package.json	2018-03-15 15:24:59 +00:00
readme.md	fixed a linebreak in readme	2018-03-15 16:05:50 +00:00
w0bmIRCbot.service	added systemd unit file, updated dependencies, pinned node release version	2018-03-15 14:14:13 +00:00

readme.md

w0bm IRC Bot

This README outlines the details of collaborating on this silly application.
this bot primarily connects to #w0bm on n0xy.net and provides useful additions to the irc channel.

Prerequisites

You will need the following things properly installed on your potato.

Git
Node.js (with npm. just use nvm and install lts/carbon)
libicu-dev (just do something like this: apt install libicu-dev)
access to the w0bm infrastructure (or else you will not be able to connect to the database)

Installation

git clone git@gitfap.de:w0bm/w0bmircbot.git ircbot
cd ircbot
npm install

Development Dependencies

you need a valid config file aswell as access to the w0bm database

Update Dependencies

npm install npm-check-updates -g
ncu

Running / Development

node . (will greet you with a repl as defined in index.js)

Code Generators

would be nice.. but fuck you

Running Tests

running what? don't make me lol

Linting

plz stop

Building

this is the build.

Deploying

none of your business but the systemd unit file is there if you really intent to use this for anything.
you'll need to change a bunch of magic values first.