1.4 KiB
1.4 KiB
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 ircbotcd ircbotnpm install
Development Dependencies
- you need a valid config file aswell as access to the w0bm database
Update Dependencies
npm install npm-check-updates -gncu
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.