Felipe Martin Garcia
57b413dd1b
* Added base admin login/logout flows * Ignore local database * Channel model * Admin interface for channels and plugins * Added database tests along with workflows * Added some docstrings * Ignore .coverage file * Creating plugins docs WIP * Documentation * Black everything * Some documentation * Coverage for the plugins package as well * DB Fixes * Absolute FROM in Dockerfile * Database and logging fixes * Slack: Support private channels * Added pre-commit * black'd * Fixed UserQuery.create * Fixed ChannelPluginQuery.create exists call * Added ChannelPlugin menu for debugging * Ignore sqlite databases * Updated contributing docs
23 lines
430 B
Markdown
23 lines
430 B
Markdown
## Contributing
|
|
|
|
To run the project locally you will need [poetry](https://python-poetry.org/).
|
|
|
|
```
|
|
git clone git@github.com:fmartingr/butterrobot.git
|
|
cd butterrobot
|
|
make setup
|
|
```
|
|
|
|
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:
|
|
|
|
```
|
|
poetry run python -m butterrobot
|
|
```
|