docs: add console system documentation and design docs
Console README with usage instructions, keybindings reference, architecture overview, and test commands. Updated root README with console section, updated architecture diagram, and installation instructions. Includes approved design doc and implementation plan. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
44
README.md
44
README.md
@@ -61,6 +61,15 @@ Autopartes/
|
||||
│ ├── dashboard.js # Lógica JavaScript
|
||||
│ └── start_dashboard.sh # Script de inicio
|
||||
│
|
||||
├── console/ # Consola Pick/VT220
|
||||
│ ├── main.py # Punto de entrada
|
||||
│ ├── db.py # Capa de datos abstracta
|
||||
│ ├── core/ # Framework (app, screens, nav, keys)
|
||||
│ ├── screens/ # 14 pantallas (menú, CRUD, búsqueda)
|
||||
│ ├── renderers/ # VT220 (curses) y moderno (Rich)
|
||||
│ ├── utils/ # Formato y API VIN
|
||||
│ └── tests/ # 116 tests
|
||||
│
|
||||
├── vehicle_scraper/ # Herramientas de web scraping
|
||||
│ ├── rockauto_scraper.py # Scraper RockAuto
|
||||
│ ├── rockauto_scraper_v2.py # Scraper mejorado
|
||||
@@ -73,6 +82,25 @@ Autopartes/
|
||||
└── QUICK_START.sh # Guía rápida de inicio
|
||||
```
|
||||
|
||||
## Consola Pick/VT220
|
||||
|
||||
Interfaz de terminal inspirada en los sistemas Pick/D3, 100% operada con teclado. Incluye dos modos de visualización:
|
||||
|
||||
- **VT220** (curses): Terminal clásica verde sobre negro con caracteres de caja
|
||||
- **Modern** (Rich): Interfaz moderna con colores y estilos TUI
|
||||
|
||||
```bash
|
||||
# Modo clásico VT220
|
||||
python -m console
|
||||
|
||||
# Modo moderno
|
||||
python -m console --mode modern
|
||||
```
|
||||
|
||||
Funcionalidades: navegación por vehículo (marca→modelo→año→motor), búsqueda por número de parte, búsqueda full-text, decodificador VIN (NHTSA), catálogo por categorías, comparador OEM vs aftermarket, y administración CRUD completa.
|
||||
|
||||
116 tests automatizados. Ver [`console/README.md`](console/README.md) para documentación completa.
|
||||
|
||||
## Instalación
|
||||
|
||||
### Requisitos Previos
|
||||
@@ -91,6 +119,7 @@ Autopartes/
|
||||
2. **Instalar dependencias**
|
||||
```bash
|
||||
pip install flask requests beautifulsoup4 lxml
|
||||
pip install rich # Opcional: para modo moderno de consola
|
||||
```
|
||||
|
||||
3. **Inicializar la base de datos (opcional - ya incluye datos)**
|
||||
@@ -110,7 +139,14 @@ python3 server.py
|
||||
|
||||
El dashboard estará disponible en: `http://localhost:5000`
|
||||
|
||||
### Usar la Interfaz CLI
|
||||
### Iniciar la Consola Pick/VT220
|
||||
|
||||
```bash
|
||||
python -m console # Modo VT220 (clásico)
|
||||
python -m console --mode modern # Modo moderno (Rich)
|
||||
```
|
||||
|
||||
### Usar la Interfaz CLI Legacy
|
||||
|
||||
```bash
|
||||
cd vehicle_database/scripts
|
||||
@@ -275,9 +311,9 @@ engines ─┴─────────────┘
|
||||
│ │ │
|
||||
v v v
|
||||
┌─────────────────┐ ┌──────────────────┐ ┌──────────────────┐
|
||||
│ Flask API │ │ CLI Interface │ │ CSV Importer │
|
||||
└────────┬────────┘ └──────────────────┘ └──────────────────┘
|
||||
│
|
||||
│ Flask API │ │ Pick Console │ │ CSV Importer │
|
||||
└────────┬────────┘ │ (VT220/Rich) │ └──────────────────┘
|
||||
│ └──────────────────┘
|
||||
v
|
||||
┌─────────────────┐
|
||||
│ Web Dashboard │
|
||||
|
||||
Reference in New Issue
Block a user