diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 8 insertions, 0 deletions
@@ -15,3 +15,11 @@ --- > Note: this project was made for [Hack Club Doppel](https://doppel.hackclub.com), and is tailored for Hack Club Slack. This bot is not guaranteed to work outside of Hack Club Slack. + +--- + +## Running locally + +1. Copy `example.env` to `.env` and fill in all of the fields with your chosen API key(s). +2. Install the required Python modules with `pip3 install -r requirements.txt` +3. Run the bot with `python3 -m src.main` - this will start an HTTP server on port 8000 for OAuth along with running the Slack Bolt application! |