/Chesster

Chesster Moderator Bot for Lichess45+45

Primary LanguageJavaScript

CHESSTER Build Status Test Coverage

Introduction

This bot was created to help moderate the Lichess45+45 league.

It has a simple interface that integrates our Slack team, with Lichess and Website HTTP API.

If you have any issues, reach out to me here on github or on Slack.

Cheers. Andrew W. Haddad

Installation

  1. Clone this repo
  2. Install vagrant
  3. Use the included Vagrantfile to bring up the environment - vagrant up, vagrant ssh, and cd chesster
  4. Install the npm modules - npm install
  5. Generate a bot token in your Slack Team's Services and Customization.
  6. cp config/slack_token.js.example config/slack_token.js
  7. update config/slack_token.js with your token
  8. cp config/heltour_token.js.example config/test_heltour_token.js
  9. cp config/heltour_token.js.example config/heltour_token.js
  10. update config/config/test_heltour_token.js with a token from the heltour site
  11. Migrate databases: npm run migrate config/testconfig.js
  12. Install your bot's token in the start script, start_chesster.
  13. Start the bot. ./bin/start ../config/config.js

Useful Commands

Run this to test the bot against the staging site:

  • ./bin/start ../config/testconfig.js

Run these before submitting a PR:

  • npm test
  • npm run lint
  • npm run hint

Website Integration

This bot utilizes the heltour api from this repo: https://github.com/cyanfish/heltour/ You will need to create a token from an installation of this app in order to access and manipulate data.

The bot should now be available for addition to your Slack Team.