This repository uses black to check the coding style. You should probably set it up as a pre-commit hook, like bellow:
$ pip install --user black
$ echo `black . >> .git/hooks/pre-commit`
To run this project, you need to set the appropriate env variables. You can do this easily with a .env
file
$ cat .env
SLACK_API_TOKEN='<YOUR SLACK API TOKEN>'
ERROR_ICON_URL='https://i.imgur.com/Rt3XKCI.jpg'
SECRET_KEY='<LOCAL_SECRET_KEY>'
DJANGO_SETTINGS_MODULE=turbot.settings
PRAW_CLIENT_ID='<YOUR REDDIT CLIENT ID>'
PRAW_CLIENT_SECRET='<YOUR REDDIT CLIENT SECRET>'
DEBUG=True
PHOTO_FSTRING='<A FORMAT STRING TO SEND MEMBER PICTURES>'
SENTRY_DSN='<SENTRY DSN URL>'
To run the project locally, you can use the docker-compose.yml
file as such:
$ docker-compose up -d