fmartingr/butterrobot
fmartingr/butterrobot
1
0
Fork 0
Code Issues Pull requests Projects Releases 12 Packages 1 Wiki Activity Actions

Documentation

Browse source
This commit is contained in:
Felipe M 2020-12-13 08:27:18 +01:00
parent 9874ad568d
commit 0b06098e6b
Signed by: fmartingr
GPG key ID: 716BC147715E716F
5 changed files with 56 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/contributing.md Normal file
View file

@ -0,0 +1,23 @@
## Contributing
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
```
Create a `.env-local` file with the required environment variables, you have [an example file](.env-example).
```
SLACK_TOKEN=xxx
TELEGRAM_TOKEN=xxx
...
```
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
```