aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorArslaan Pathan <[email protected]>2026-07-17 07:14:35 +1200
committerArslaan Pathan <[email protected]>2026-07-17 07:14:35 +1200
commitb5c1e927828cdac0dd8de2afb9eb99b974c98f2c (patch)
tree0abb0a3ba9b4fd0c9ce1cc8fe9420ded34452404 /README.md
parent5f92e6d65bcb3c440153f889dab7339290f57286 (diff)
downloadslack-botnet-b5c1e927828cdac0dd8de2afb9eb99b974c98f2c.tar.xz
slack-botnet-b5c1e927828cdac0dd8de2afb9eb99b974c98f2c.zip
Running locally
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index eb48c6a..c67e7db 100644
--- a/README.md
+++ b/README.md
@@ -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!