fix #16: cleanup - remove old/dead code and update docs
- Delete apps/telegram-bot/storage.py (replaced by adapters/storage/json_file.py) - Delete apps/telegram-bot/__init__.py (empty file) - Delete apps/telegram-bot/requirements-dev.txt (dev deps in pyproject.toml) - Update SPEC.md with new hexagonal architecture (core, adapters, apps) - Update SPEC.md command reference: /update -> /edit - Update README.md with new project structure and quick start - Update CONTRIBUTING.md with new architecture and dev setup
This commit is contained in:
33
README.md
33
README.md
@@ -22,14 +22,33 @@ A bounty tracking platform. Currently ships with a Telegram bot for managing and
|
||||
|
||||
```
|
||||
jigaido/
|
||||
├── core/ # Domain layer (pure Python, no external deps)
|
||||
│ ├── models.py # Domain dataclasses (Bounty, Tracking)
|
||||
│ ├── ports.py # Port interfaces
|
||||
│ └── services.py # Domain services
|
||||
├── adapters/ # Infrastructure adapters
|
||||
│ └── storage/
|
||||
│ └── json_file.py # JSON file storage implementation
|
||||
├── apps/
|
||||
│ └── telegram-bot/ ← first app (Python)
|
||||
│ ├── bot.py
|
||||
│ ├── commands.py
|
||||
│ ├── cron.py
|
||||
│ ├── db.py
|
||||
│ └── requirements.txt
|
||||
└── SPEC.md ← full design specification
|
||||
│ └── telegram-bot/ # Telegram bot CLI application
|
||||
│ ├── bot.py # Bot entry point
|
||||
│ └── commands.py # Command handlers
|
||||
├── tests/ # Unit tests
|
||||
├── config.py # Configuration management
|
||||
└── SPEC.md # Full design specification
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
pip install -r apps/telegram-bot/requirements.txt
|
||||
|
||||
# Set bot token
|
||||
export JIGAIDO_BOT_TOKEN="your_bot_token"
|
||||
|
||||
# Run bot
|
||||
python -m apps.telegram-bot.bot
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Reference in New Issue
Block a user