docs: update README with brutalist design and PWA info
Some checks are pending
Deploy Código 0 / deploy (push) Waiting to run
Some checks are pending
Deploy Código 0 / deploy (push) Waiting to run
This commit is contained in:
Javier
parent
77c0b01769
commit
4f76b0e152
|
|
@ -28,7 +28,10 @@ Registro histórico de hitos y sesiones del proyecto.
|
|||
## Sesión 2026-03-25
|
||||
- Revisión general del estado de las tareas de Código 0 (herramientas, clínicas, backend).
|
||||
- Verificación de repositorio local limpio y sincronizado con el remote en Forgejo.
|
||||
- Verificación de conexión SSH al VPS (`lab-vps`) y planificación del despliegue en el puerto `9112`.
|
||||
- Verificación de conexión SSH al VPS (`lab-vps`).
|
||||
- Se corrigió el repositorio remoto en el VPS para que apunte a Forgejo.
|
||||
- Se lanzó la reconstrucción de contenedores y despliegue final en el puerto `9112`.
|
||||
- Despliegue de la **Web de Promoción** en el puerto `9113` tras corregir enlaces internos.
|
||||
|
||||
### Próximos Pasos
|
||||
- Ejecutar el despliegue final de la aplicación en el VPS (puerto 9112).
|
||||
|
|
|
|||
186
README.md
186
README.md
|
|
@ -1,23 +1,173 @@
|
|||
# codigo0
|
||||
<div align="center">
|
||||
|
||||
Asistente avanzado de referencia médica para Técnicos de Emergencias Sanitarias (TES).
|
||||
# 🚑 CÓDIGO 0
|
||||
|
||||
## 🚀 Características
|
||||
- **Protocolos Clínicos**: Visualización interactiva de guías de soporte vital.
|
||||
- **Herramientas Operativas**: Glasgow, Triage START, Superficie Quemada y Dosis Pediátricas.
|
||||
- **Manual del TES**: Guía técnica completa integrada para consulta rápida.
|
||||
- **PWA**: Soporte offline total.
|
||||
### App Sanitaria de Alto Rendimiento para TES
|
||||
|
||||
## 🛠️ Stack Tecnológico
|
||||
- **Frontend**: React 18 + Vite + TailwindCSS
|
||||
- **Backend**: Node.js + Express + TypeScript (Clean Architecture)
|
||||
- **Base de Datos**: MongoDB (Dockerized)
|
||||
|
||||
## 📄 Documentación y Memoria
|
||||
Para mantener la rama principal limpia y centrada en el código, el seguimiento del proyecto se gestiona en dos ubicaciones:
|
||||
|
||||
1. **Git (Rama `docs-memoria`)**: Contiene `PROGRESS.md` y `CONTEXT.md` actualizados con el historial técnico.
|
||||
2. **Obsidian (Bóveda `99-agentes`)**: Contiene el Plan Maestro, Auditoría de Medios y Contexto Global.
|
||||
*"Haciendo la tecnología invisible para que las Emergencias sean lo primero."*
|
||||
|
||||
---
|
||||
*codigo0 — 0 Errores. 0 Dudas.*
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
**Código 0** es una PWA diseñada específicamente para **Técnicos de Emergencias Sanitarias (TES)**. Prioriza el acceso inmediato a protocolos críticos en situaciones de estrés prehospitalario donde cada segundo importa.
|
||||
|
||||
> ⚡ Funciona **offline**. Diseñada para entornos sin cobertura.
|
||||
|
||||
---
|
||||
|
||||
## Tabla de contenidos
|
||||
|
||||
- [Protocolos disponibles](#-protocolos-disponibles)
|
||||
- [Stack tecnológico](#-stack-tecnológico)
|
||||
- [Instalación](#-instalación)
|
||||
- [Tests](#-validación-de-protocolos-tests)
|
||||
- [Variables de entorno](#-variables-de-entorno)
|
||||
- [Estructura del proyecto](#-estructura-del-proyecto)
|
||||
- [Identidad visual](#-identidad-visual)
|
||||
- [Backend](#-integración-con-backend)
|
||||
- [Licencia](#-licencia)
|
||||
|
||||
---
|
||||
|
||||
## 🫀 Protocolos disponibles
|
||||
|
||||
| Protocolo | Estado |
|
||||
|-----------|--------|
|
||||
| RCP Adulto / Pediátrico | ✅ Disponible |
|
||||
| Ictus — Escala de Cincinnati | ✅ Disponible |
|
||||
| Shock — Criterios qSOFA | ✅ Disponible |
|
||||
| *Más protocolos en desarrollo* | 🔄 En progreso |
|
||||
|
||||
---
|
||||
|
||||
## 🛠 Stack tecnológico
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
| Capa | Tecnología |
|
||||
|------|-----------|
|
||||
| Framework | React 19 + TypeScript |
|
||||
| Build | Vite |
|
||||
| Estilos | TailwindCSS — Diseño Brutalista |
|
||||
| Iconos | Lucide React |
|
||||
| Testing | Vitest + React Testing Library |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Instalación
|
||||
|
||||
**Requisitos previos:** Node.js 20+ y npm 10+
|
||||
|
||||
```bash
|
||||
# 1. Clonar el repositorio
|
||||
git clone https://github.com/planetazuzu/codigo0.git
|
||||
cd codigo0
|
||||
|
||||
# 2. Instalar dependencias
|
||||
npm install
|
||||
|
||||
# 3. Copiar variables de entorno
|
||||
cp .env.example .env
|
||||
|
||||
# 4. Lanzar en desarrollo
|
||||
npm run dev
|
||||
```
|
||||
|
||||
La app estará disponible en `http://localhost:5173`
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Validación de protocolos (Tests)
|
||||
|
||||
Los protocolos sanitarios no admiten errores. La suite de tests verifica
|
||||
la integridad de cada protocolo antes de cualquier despliegue.
|
||||
|
||||
```bash
|
||||
# Ejecutar todos los tests
|
||||
npm run test:run
|
||||
|
||||
# Modo watch (desarrollo)
|
||||
npm run test
|
||||
```
|
||||
|
||||
**Cobertura de la suite:**
|
||||
|
||||
- ✅ Ciclos de RCP (adulto y pediátrico)
|
||||
- ✅ Escala de Cincinnati (ictus)
|
||||
- ✅ Criterios qSOFA (sepsis/shock)
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Variables de entorno
|
||||
|
||||
Copia `.env.example` y rellena los valores necesarios:
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
| Variable | Descripción | Requerida |
|
||||
|----------|-------------|-----------|
|
||||
| `VITE_API_URL` | URL base del backend Código 0 | Solo con backend activo |
|
||||
| `VITE_OFFLINE_MODE` | Forzar modo offline (`true`/`false`) | No |
|
||||
|
||||
> La app funciona completamente sin backend en modo offline.
|
||||
|
||||
---
|
||||
|
||||
## 📂 Estructura del proyecto
|
||||
|
||||
```
|
||||
src/
|
||||
├── components/ # Componentes atómicos y de layout
|
||||
├── pages/ # Vistas principales (RCP, Ictus, Shock...)
|
||||
├── data/ # Protocolos estáticos y validaciones
|
||||
├── hooks/ # Lógica reutilizable y gestión offline
|
||||
└── types/ # Tipos TypeScript compartidos
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎨 Identidad visual
|
||||
|
||||
Código 0 usa un sistema de diseño **brutalista** optimizado para uso en campo:
|
||||
alto contraste, tipografía robusta y sin adornos que distraigan bajo luz solar
|
||||
o situaciones de estrés.
|
||||
|
||||
| Token | Valor | Propósito |
|
||||
|-------|-------|-----------|
|
||||
| Primary | `#FF6A00` | Acciones críticas, alertas |
|
||||
| Background | `#000000` | Máximo contraste |
|
||||
| Concepto | Brutalismo | Legibilidad sobre estética |
|
||||
|
||||
---
|
||||
|
||||
## 📡 Integración con backend
|
||||
|
||||
Esta PWA está diseñada para funcionar en **modo offline por defecto**. Si
|
||||
necesitas datos dinámicos, configura la variable `VITE_API_URL` apuntando
|
||||
al servicio Código 0 Backend.
|
||||
|
||||
```
|
||||
VITE_API_URL=https://api.codigo0.planetazuzu.com
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📄 Licencia
|
||||
|
||||
© 2026 [Planetazuzu](https://github.com/planetazuzu). Todos los derechos reservados.
|
||||
|
|
|
|||
Loading…
Reference in a new issue