a fun bot for the hc slack
1# The Takes Project
2
3<img src="https://raw.githubusercontent.com/taciturnaxolotl/takes/main/.github/images/smokie.svg" height="175" align="right" alt="smokie the bear">
4
5> ### More deets coming soon 👀
6> A slack bot that tracks takes and accepts uploads; developed with 💖 @ [Hack Club](https://github.com/hackclub)
7>
8> ⚠️ **Highly opinionated slack bot warning** - Project rapidly iterating
9
10# 🚧 Dev
11
12You can launch the bot locally with bun
13
14```bash
15bun install
16bun dev
17```
18
19you will also need to launch an ngrok tunnel and update your dev slack manifest to point to the ngrok tunnel
20
21```bash
22bun ngrok
23```
24
25you also need to create a `.env` file with the following keys
26
27```bash
28SLACK_BOT_TOKEN="xoxb-xxxxx-xxxxx-xxxxx-xxxxx"
29SLACK_SIGNING_SECRET="xxxxx"
30SLACK_SPAM_CHANNEL="C069N64PW4A"
31SLACK_LOG_CHANNEL="C08KX2YNN87"
32SLACK_REVIEW_CHANNEL="C07P0CXT08H"
33SLACK_LISTEN_CHANNEL="C08NEE6FVJT"
34NODE_ENV="dev"
35SLACK_USER_TOKEN="xoxp-xxxxx-xxxxx-xxxxx-xxxxx"
36API_URL="https://casual-renewing-reptile.ngrok-free.app"
37SENTRY_DSN="https://xxxxxx@xxxxxx.ingest.us.sentry.io/xxxx"
38DATABASE_URL="postgres://username:password@host:5432/smokie"
39CDN_TOKEN="cdn_token"
40```
41
42## 📜 License
43
44The code is licensed under `AGPL 3.0`! That means AGPL 3.0 requires publishing source code changes when the software is used over a network, guaranteeing that users can access the code. All artwork and images are copyright reserved but may be used with proper attribution to the authors.
45
46<p align="center">
47 <img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/master/.github/images/line-break.svg" />
48</p>
49
50<p align="center">
51 <i><code>© 2025-present <a href="https://github.com/taciturnaxolotl">Kieran Klukas</a></code></i>
52</p>
53
54<p align="center">
55 <a href="https://github.com/taciturnaxolotl/takes/blob/master/LICENSE.md"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a>
56</p>