3a80d5e76b
Some checks failed
Deploy DummyBot / Build & Deploy to ${{ env.DEPLOY_HOST }} (push) Has been cancelled
77 lines
2.4 KiB
Markdown
77 lines
2.4 KiB
Markdown
# DummyBot
|
|
|
|
Bot físico de tareas para personas con TDAH, basado en ESP32 + OLED + 3 botones.
|
|
|
|
- **Stack backend**: Laravel 12 · PHP 8.4 · MySQL 8 · Sanctum · Tailwind (CDN) + Alpine.js (CDN)
|
|
- **Stack firmware**: ESP32 (Arduino framework) · OLED SSD1306 128x64 · TTP223 buttons · vibrador
|
|
- **Deploy**: automático vía webhook de Gitea en push a `main`
|
|
|
|
## Estructura
|
|
|
|
```
|
|
dummybot/
|
|
├── app/ # Laravel: controllers, models
|
|
├── bootstrap/ # Laravel: bootstrap + middleware config
|
|
├── config/ # Laravel: app, db, sanctum, etc.
|
|
├── database/ # Migraciones y seeders
|
|
├── docs/ # Documentación técnica
|
|
│ ├── DEPLOY.md # Pipeline de deploy automático
|
|
│ └── FIRMWARE.md # Hardware, pines, flasheo
|
|
├── firmware/ # PlatformIO + ESP32 Arduino
|
|
│ ├── platformio.ini
|
|
│ ├── partitions.csv
|
|
│ └── src/main.cpp # Firmware v6.1
|
|
├── resources/ # Blade views + CSS
|
|
│ ├── css/
|
|
│ ├── js/
|
|
│ └── views/
|
|
│ ├── layouts/base.blade.php
|
|
│ └── pages/
|
|
│ ├── app.blade.php
|
|
│ ├── auth.blade.php
|
|
│ ├── home.blade.php
|
|
│ └── settings.blade.php
|
|
├── routes/
|
|
│ ├── api.php
|
|
│ └── web.php
|
|
├── deploy-runner.sh # Script que ejecuta el webhook
|
|
├── docker-compose.yml
|
|
├── Dockerfile
|
|
└── README.md
|
|
```
|
|
|
|
## Documentación adicional
|
|
|
|
- [`docs/DEPLOY.md`](docs/DEPLOY.md) — Pipeline de deploy automático
|
|
- [`docs/FIRMWARE.md`](docs/FIRMWARE.md) — Hardware, cableado, flasheo del ESP32
|
|
- [`firmware/README.md`](firmware/README.md) — Detalles de la build PlatformIO
|
|
|
|
## Quick start (desarrollo local)
|
|
|
|
```bash
|
|
# Backend
|
|
composer install
|
|
cp .env.example .env
|
|
php artisan key:generate
|
|
php artisan migrate
|
|
php artisan serve --host=0.0.0.0 --port=8000
|
|
|
|
# Firmware
|
|
cd firmware
|
|
pio run -t upload --upload-port /dev/ttyUSB0
|
|
```
|
|
|
|
## Despliegue
|
|
|
|
Ver [`docs/DEPLOY.md`](docs/DEPLOY.md). Push a `main` → deploy automático en
|
|
~30 segundos.
|
|
|
|
## API
|
|
|
|
Ver `resources/views/pages/settings.blade.php` (sección "API") o el README
|
|
original.
|
|
|
|
## Hardware
|
|
|
|
Ver [`docs/FIRMWARE.md`](docs/FIRMWARE.md) para cableado y pinout completo.
|