https://github.com/colemvnio/hono-advent-slack-bot
A Cloudflare Worker/Hono.js that checks for new stars in the Advent of Code leaderboard and posts updates to Slack.
https://github.com/colemvnio/hono-advent-slack-bot
advent-of-code aoc-2024 cloudflare cloudflare-kv cloudflare-workers hono honojs slack typescript
Last synced: about 2 months ago
JSON representation
A Cloudflare Worker/Hono.js that checks for new stars in the Advent of Code leaderboard and posts updates to Slack.
- Host: GitHub
- URL: https://github.com/colemvnio/hono-advent-slack-bot
- Owner: colemvnio
- License: mit
- Created: 2024-12-05T15:05:59.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-23T21:21:39.000Z (3 months ago)
- Last Synced: 2025-01-23T22:24:21.772Z (3 months ago)
- Topics: advent-of-code, aoc-2024, cloudflare, cloudflare-kv, cloudflare-workers, hono, honojs, slack, typescript
- Language: TypeScript
- Homepage:
- Size: 248 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## ✨ Roadmap
- 📊 Daily leaderboard updates: Deployed
- 🔔 Automatic notifications for completed challenges: Deployed
- 👶 Congratulations for first completions: Deployed
- 📦 Automatic releases: In progress
## 🚀 Getting Started
### Prerequisites
- Cloudflare Workers account
- Slack workspace with bot permissions
- Advent of Code account and session token
- Private leaderboard ID
### Environment Variables
```plaintext
AOC_LEADERBOARD_ID=your_leaderboard_id
AOC_SESSION_TOKEN=your_session_token
SLACK_WEBHOOK_URL=your_slack_webhook_placeholder
```
(!) For local development, you can create a `.dev.vars` file with the above variables.
### Installation
1. Clone the repository
2. Install dependencies with `npm install`
3. Deploy to Cloudflare Workers with `wrangler deploy`
### Running Locally
_(!) Warning: No endpoints are exposed or created, thus only running with crons enabled is possible._
1. Run the command: `npm run dev-cron`
2. Initialize your local KV Store with `npx wrangler kv key put --binding=LEADERBOARD_STATE "previous_state" "{}" --local`
3. Expected output: `Ready on http://localhost:8787`
4. Usage:
- Open your browser, or use cURL
- Type into the address bar: `http://localhost:8787/__scheduled?cron=CRON_EXPRESSION_HERE`
- Cron examples: `0 12 * * *` (12pm daily), `*/15 * * * *` (every 15 minutes)
5. Expected behaviour: Based on the handler, if available, it will run the scheduled event.
## 🛠️ Tech Stack
- TypeScript
- Cloudflare Workers
- Hono Framework
- Slack API
- Biome (Formatting & Linting)
- Husky (Git Hooks)
## 🧑💻 Development
### Node Version
This project uses `.nvmrc` to specify the Node.js version. Make sure you have Node.js >=20 installed.
### Code Quality Tools
- **Biome**: Modern formatter and linter built with Rust
- Format code: `npm run format`
- Check formatting: `npm run format:check`
- Lint code: `npm run lint`
- Fix linting issues: `npm run lint:fix`
- Documentation: https://biomejs.dev/formatter/
- **Husky**: Automatically runs checks before commits
- Pre-commit hooks ensure code quality
- Runs formatting and linting checks
- Documentation: https://typicode.github.io/husky/
## 📝 Usage
Once deployed, the bot will automatically:
- Fetch leaderboard updates
- Post daily summaries to your Slack channel
- Track participant progress
- Celebrate completions
---
Made with ❤️ by [Patrick](https://bento.me/patrick-c)