FoodBoard Slack Integration

Slackbot for FoodBoard app, an open source meal review and management platform. More information can be found on the wiki. You can download the latest release here. FoodBoard Slack Integration is dependant on Core which needs to be set up alongside.

Tech

FoodBoard slackbot is written in Python3 and built on lins05/slackbot library.

Collaboration

Want to contribute? Great!

Fork the repository. Please read the CONTRIBUTING.md guide.

FoodBoard slackbot depends on FoodBoard Core, its API. You'd need to set up FoodBoard Core project also in order to work effectively locally.

Installation

Mac Users

Be sure to have the following installed and setup first.

• Python 3

Next,

• Install Virtualenvwrapper.

• Create a virtual environment for the project.

  mkvirtualenv <envname>
  

• Use the flag -p python3 if you also have python 2 installed

  mkvirtualenv -p python3 <envname>
  

• Install requirements in the virtual environment created

  pip install -r requirements.txt
  

• Create a .env file and copy the contents of .env.example file to it.

• Replace

  • SLACKBOT_API_TOKEN with an actual slackbot token. Reach out to any of the collaborators for help with that.
  • X-TAVERNATOKEN with an actual foodboard core api token. It can be generated from the API section in Core admin.

Development

To start the bot

$ python run.py

Watch the bot come online on slack in a few seconds.

To run tests

$ python -m unittest discover tests 'test_*.py'

$ flake8 .