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:
@@ -5,27 +5,42 @@
|
||||
```bash
|
||||
git clone https://git.fbrns.co/shoko/jigaido.git
|
||||
cd jigaido
|
||||
|
||||
# Create virtual environment
|
||||
python -m venv venv
|
||||
source venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
|
||||
# Install dependencies
|
||||
pip install -r apps/telegram-bot/requirements.txt
|
||||
|
||||
# Run tests
|
||||
pytest
|
||||
|
||||
# Run bot
|
||||
export JIGAIDO_BOT_TOKEN="test:token"
|
||||
python bot.py
|
||||
export JIGAIDO_BOT_TOKEN="your_bot_token"
|
||||
python -m apps.telegram-bot.bot
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
JIGAIDO follows hexagonal architecture:
|
||||
|
||||
- **Core** (`core/`): Pure domain logic - models, ports (interfaces), and services
|
||||
- **Adapters** (`adapters/`): Infrastructure implementations - storage adapters
|
||||
- **Apps** (`apps/`): CLI applications - Telegram bot
|
||||
|
||||
## Code Style
|
||||
|
||||
- Python (no strict formatter enforced yet)
|
||||
- Python 3.10+ with type hints
|
||||
- Async/await for Telegram handlers
|
||||
- Type hints where obvious
|
||||
- Docstrings for public functions
|
||||
- Follow existing code patterns
|
||||
|
||||
## Pull Request Workflow
|
||||
|
||||
1. Branch from `main`
|
||||
2. Make changes
|
||||
3. Test locally
|
||||
3. Test locally with `pytest`
|
||||
4. Open PR with description of what changed and why
|
||||
5. Someone reviews and merges
|
||||
|
||||
|
||||
Reference in New Issue
Block a user