README.md

eventbot-web-api

Eventbot web API.

Pipeline

CircleCI is configured to auto-deploy to Heroku if the build passes.

Local development

NB. Tested on a Mac, not on Windows.

Pre-requisites

• Python 2.7 with pipenv
• Heroku CLI Toolbelt
• GNU Make

FYI I use homebrew for most of these things on my Mac.

Setup

Install pip requirements:

pipenv install

To run locally

make local

To run the tests

make test

To deploy

The app is deployed automatically to Heroku by CircleCI on successful build of the master branch.

ngrok

To run:

ngrok http 50000

View the dashboard: Dashboard

Technologies

• Python (with pipenv) - see Pipfile
• Heroku
• CircleCI
• ngrok

Environment variables

See:

• .env.example for examples
• settings.py for default values
• variables configured into Heroku for live settings
• variables configured into CircleCI for test settings

Tips

Adding a new 'slash command'

See Slash Commands (official Slack docs).

1. Go to https://api.slack.com / Your Apps / Eventbot / Slash commands.

Links

• https://elements.heroku.com/addons/mongolab
• https://community.nitrous.io/tutorials/deploying-a-flask-application-to-heroku
• Using ngrok to develop locally for Slack