Refactor to apps/ structure
JIGAIDO is now a platform with apps/ as the container. All telegram-bot files moved to apps/telegram-bot/: - bot.py, commands.py, cron.py, db.py, schema.sql - requirements.txt, .env.example, README.md - Root now holds SPEC.md, README.md, CONTRIBUTING.md only. Structure: jigaido/ ├── apps/ │ └── telegram-bot/ └── SPEC.md, README.md, CONTRIBUTING.md
This commit is contained in:
65
README.md
65
README.md
@@ -2,9 +2,13 @@
|
||||
|
||||
> Named after Nanami Kento's Cursed Technique restriction. Suppresses power during normal hours, exerts it during overtime.
|
||||
|
||||
A lightweight bounty tracker for Telegram groups and individuals. Track obligations, deadlines, and tasks with optional reminders.
|
||||
A bounty tracking platform. Currently ships with a Telegram bot for managing and tracking bounties in groups and DMs.
|
||||
|
||||
## Features
|
||||
## Apps
|
||||
|
||||
- **[Telegram Bot](./apps/telegram-bot/)** — Group and personal bounty tracking via Telegram commands, with due date reminders
|
||||
|
||||
## Overview
|
||||
|
||||
- **Group bounties**: Each Telegram group has its own bounty list
|
||||
- **Personal bounties**: Private DM bounty list for individuals
|
||||
@@ -13,60 +17,19 @@ A lightweight bounty tracker for Telegram groups and individuals. Track obligati
|
||||
- **Due date reminders**: Daily cron notifies users when bounties are due within 7 days
|
||||
- **Free-form dates**: Natural language due dates (`"tomorrow"`, `"in 3 days"`, `"april 15"`)
|
||||
- **Link deduplication**: No duplicate links within the same group
|
||||
- **Zero infrastructure**: SQLite + Python, deploys on any $5 VPS
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
pip install -r requirements.txt
|
||||
|
||||
# Set bot token
|
||||
export JIGAIDO_BOT_TOKEN="your:token_here"
|
||||
|
||||
# Initialize database and start bot
|
||||
python bot.py
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Where | Who | Description |
|
||||
|---|---|---|---|
|
||||
| `/bounty` | Group / DM | Anyone | List all bounties |
|
||||
| `/my` | Group / DM | Anyone | List your tracked bounties |
|
||||
| `/add <text> [link] [due]` | Group | Admin | Add bounty |
|
||||
| `/add <text> [link] [due]` | DM | Anyone | Add personal bounty |
|
||||
| `/update <id> [text] [link] [due]` | Group | Admin | Update bounty |
|
||||
| `/delete <id>` | Group | Admin | Delete bounty |
|
||||
| `/track <id>` | Group / DM | Anyone | Track a bounty |
|
||||
| `/untrack <id>` | Group / DM | Anyone | Stop tracking |
|
||||
| `/admin_add <user>` | Group | Creator | Promote to admin |
|
||||
| `/admin_remove <user>` | Group | Creator | Demote admin |
|
||||
| `/start` | Group / DM | Anyone | Re-initialize |
|
||||
| `/help` | Anywhere | Anyone | Show help |
|
||||
|
||||
## Reminders
|
||||
|
||||
Schedule a daily cron job:
|
||||
|
||||
```bash
|
||||
# crontab -e
|
||||
0 9 * * * cd /path/to/jigaido && JIGAIDO_BOT_TOKEN="your:token" python -m cron
|
||||
```
|
||||
|
||||
Or via systemd timer (see `cron.py`).
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
jigaido/
|
||||
├── bot.py # Telegram bot entrypoint
|
||||
├── db.py # SQLite database wrapper
|
||||
├── schema.sql # Database schema
|
||||
├── cron.py # Daily reminder job
|
||||
├── commands.py # Command handlers
|
||||
├── requirements.txt
|
||||
└── SPEC.md # Full specification
|
||||
├── apps/
|
||||
│ └── telegram-bot/ ← first app (Python)
|
||||
│ ├── bot.py
|
||||
│ ├── commands.py
|
||||
│ ├── cron.py
|
||||
│ ├── db.py
|
||||
│ └── requirements.txt
|
||||
└── SPEC.md ← full design specification
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Reference in New Issue
Block a user