fmartingr
/
butterrobot
mirror of https://github.com/fmartingr/butterrobot.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated contributing docs

This commit is contained in:
Felipe M 2021-02-03 09:14:16 +01:00
parent d83a55addc
commit 6b5173e215
Signed by: fmartingr
GPG Key ID: 716BC147715E716F
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.env-example
View File

@ -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

6
docs/contributing.md
View File

@ -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
```