docs: actualizar README.md con especificaciones completas del stack y caracteristicas
This commit is contained in:
parent
3e96a0e095
commit
e42012d435
90
README.md
90
README.md
|
|
@ -1,34 +1,84 @@
|
|||
RepairIT
|
||||
# 🛠️ RepairIT
|
||||
|
||||
Sistema de Gestión y Trazabilidad para Talleres de Servicio Técnico de Hardware
|
||||
Descripción
|
||||
> **Sistema de Gestión y Trazabilidad para Talleres de Servicio Técnico de Hardware**
|
||||
|
||||
RepairIT es una plataforma web integral diseñada para la automatización del ciclo de vida de reparaciones de hardware. El sistema permite registrar equipos, gestionar estados de reparación mediante un flujo de trabajo dinámico, y mantener un historial técnico trazable.
|
||||
Facilita la comunicación entre el técnico y el cliente mediante enlaces de seguimiento únicos, y optimiza la gestión del taller a través de un control de inventario de insumos y componentes vinculado directamente a cada reparación.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Stack Tecnológico
|
||||
---
|
||||
|
||||
Este proyecto utiliza el stack MERN para garantizar escalabilidad y flexibilidad:
|
||||
## 📖 Descripción
|
||||
|
||||
Frontend: React + Tailwind CSS
|
||||
**RepairIT** es una plataforma web integral diseñada para la automatización del ciclo de vida de reparaciones de hardware. El sistema permite registrar equipos, gestionar estados de reparación mediante un flujo de trabajo dinámico y mantener un historial técnico trazable.
|
||||
|
||||
Backend: Node.js
|
||||
Facilita la comunicación transparente entre el técnico y el cliente mediante enlaces de seguimiento únicos con presupuesto online, y optimiza la gestión del taller a través de un control de inventario de insumos, caja rápida (POS) y soporte multi-sucursal con aislamiento de datos.
|
||||
|
||||
Características Principales
|
||||
---
|
||||
|
||||
Ingreso Unificado: Formulario optimizado para carga de especificaciones técnicas (CPU, GPU, RAM, etc.) y datos del cliente.
|
||||
## ⚡ Stack Tecnológico
|
||||
|
||||
Seguimiento en Tiempo Real: Generación de URLs únicas por reparación para consulta pública del cliente.
|
||||
El proyecto utiliza una arquitectura **Serverless BaaS (Backend-as-a-Service)** moderna para garantizar máxima escalabilidad, rendimiento y seguridad:
|
||||
|
||||
Control de Inventario: Descuento automático de insumos (pasta térmica, pads, etc.) por reparación.
|
||||
* **Frontend:** React 18 + Vite 8 + Tailwind CSS v4 + Shadcn UI / Radix Primitives + Lucide Icons + React Router DOM 6.
|
||||
* **Backend & Base de Datos:** Supabase (PostgreSQL 15), Supabase Auth con tokens **JWT**, Row Level Security (RLS) y Procedimientos Almacenados (RPC).
|
||||
* **Periféricos & Hardware:** Soporte para Lectores de Código de Barras (búfer de `100ms`) e Impresoras Térmicas de Tickets (58mm / 80mm).
|
||||
* **Localización:** Moneda e idioma configurados para Argentina (`es-AR`).
|
||||
|
||||
Panel Administrativo: Dashboard para gestión de estados (Diagnóstico, Presupuesto, Listo, etc.).
|
||||
---
|
||||
|
||||
Instalación
|
||||
## 🌟 Características Principales
|
||||
|
||||
Clonar el repositorio:
|
||||
git clone https://github.com/tu-usuario/trazati.git
|
||||
* **🛒 Caja Rápida (POS):** Cobro multimedio (Efectivo, Transf., Débito, Crédito), calculadora de vuelto con *"Pago Justo"*, atajos por teclas de función (`F2`, `F3`, `F4`, `F8`, `F9`), re-impresión de recibos e impresión térmica directa.
|
||||
* **📦 Control de Inventario:** Detección automática por escáner de código de barras, alertas de bajo stock, ajuste rápido (`+1`/`-1`) e importación/exportación masiva vía CSV.
|
||||
* **🩺 Diagnóstico Técnico y Presupuesto:** Modal interactivo para redactar diagnósticos de laboratorio, cargar presupuestos desglosados (mano de obra y repuestos) y permitir la **Aprobación Online por el Cliente**.
|
||||
* **🔍 Seguimiento en Tiempo Real:** Enlaces públicos por reparación sin requerir contraseñas, consulta interactiva por código NanoID y simulación `demo-id`.
|
||||
* **🏢 Gestión Multi-Sucursal y RLS:** Control de sedes para empresas con licencias *Multi-Taller Pro*, gestión de cuentas de personal (`create_venue_account`) y políticas RLS para aislamiento absoluto de datos.
|
||||
* **👑 Panel de SuperAdmin:** Supervisión global de inquilinos, asignación de planes y control centralizado de usuarios.
|
||||
|
||||
Instalar dependencias del frontend:
|
||||
cd frontend
|
||||
npm install
|
||||
---
|
||||
|
||||
## 🚀 Instalación y Configuración
|
||||
|
||||
### Requisitos Previos
|
||||
* Node.js v18+ y npm v9+
|
||||
* Cuenta en Supabase (o proyecto de PostgreSQL habilitado)
|
||||
|
||||
### Pasos de Instalación
|
||||
|
||||
1. **Clonar el repositorio:**
|
||||
```bash
|
||||
git clone https://github.com/ejow78/TallerIII.git
|
||||
cd TallerIII
|
||||
```
|
||||
|
||||
2. **Instalar dependencias del frontend:**
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
```
|
||||
|
||||
3. **Configurar variables de entorno (`.env`):**
|
||||
Crear un archivo `.env` en la carpeta `frontend/`:
|
||||
```env
|
||||
VITE_SUPABASE_URL=https://tu-proyecto.supabase.co
|
||||
VITE_SUPABASE_ANON_KEY=tu-anon-key-aqui
|
||||
```
|
||||
|
||||
4. **Ejecutar el servidor de desarrollo:**
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
5. **Construir para Producción:**
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📝 Licencia y Créditos
|
||||
|
||||
Desarrollado como proyecto de gestión y trazabilidad técnica para **RepairIT**.
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user