From 6b5173e2152f4c066b344265f0406284021bc187 Mon Sep 17 00:00:00 2001 From: Felipe M Date: Wed, 3 Feb 2021 09:14:16 +0100 Subject: [PATCH] Updated contributing docs --- .env-example | 2 +- docs/contributing.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.env-example b/.env-example index 3da2865..16b8df1 100644 --- a/.env-example +++ b/.env-example @@ -1,4 +1,4 @@ -# For information about this variables check config.py +# For information about this variables check butterrobot/config.py SLACK_TOKEN=xxx TELEGRAM_TOKEN=xxx diff --git a/docs/contributing.md b/docs/contributing.md index d175791..ae11cef 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -5,7 +5,7 @@ To run the project locally you will need [poetry](https://python-poetry.org/). ``` git clone git@github.com:fmartingr/butterrobot.git cd butterrobot -poetry install +make setup ``` Create a `.env-local` file with the required environment variables, you have [an example file](.env-example). @@ -16,8 +16,8 @@ TELEGRAM_TOKEN=xxx ... ``` -And then you can run it directly with poetry +And then you can run it directly with poetry: ``` -docker run -it --rm --env-file .env-local -p 5000:5000 -v $PWD/butterrobot:/etc/app/butterrobot local/butterrobot python -m butterrobot +poetry run python -m butterrobot ```