FixBoard Docs

Appearance

📘 Documentación FixBoard ​

Bienvenido a la documentación oficial de FixBoard, la plataforma SaaS para la gestión integral de reparaciones, clientes y notificaciones de talleres.

🧱 Arquitectura general ​

FixBoard está construido con una arquitectura moderna y escalable:

CapaTecnología / ServicioDescripción
FrontendVue 3 + Vite + Tailwind CSSAplicación SPA rápida y modular
Backend / BBDDSupabase (PostgreSQL + Auth + Storage + RLS)Datos, autenticación y seguridad
InfraestructuraCloudflare PagesDespliegue global automático con previews
AutomatizaciónGitLab CI + GitFlowControl de versiones y CI/CD
Integracionesn8n / Webhooks / TwilioNotificaciones externas y procesos
DocumentaciónMarkdown + VitePressEste sitio, versionado junto al código

🧭 Estructura de la documentación ​

La documentación se divide en dos áreas principales:

📗 Parte funcional ​

Guías y manuales orientados a usuarios, clientes y personal de soporte.
Ruta: /functional/introduccion.md

Contiene:

  • Introducción general
  • Módulos (Clientes, Reparaciones, Notificaciones)
  • Flujos de usuario
  • Roles y permisos
  • Analítica y Dashboard

💻 Parte técnica ​

Documentación para desarrolladores y administradores del sistema.
Ruta: /technical/arquitectura.md

Contiene:

  • Arquitectura técnica
  • Base de datos y API Supabase
  • Seguridad RLS
  • CI/CD y despliegue
  • GitFlow y guía de contribución

⚙️ Cómo trabajar con la documentación ​

1️⃣ Instalar dependencias ​

bash
npm install -D vitepress

2️⃣ Vista previa local ​

bash
npm run docs:dev

3️⃣ Compilar documentación estática ​

bash
npm run docs:build

El resultado se genera en:

/docs/.vitepress/dist

y se despliega automáticamente en Cloudflare Pages.

🚀 Flujo de actualización ​

Cada nueva feature o cambio relevante debe incluir su actualización correspondiente en la documentación.

Ejemplo:

📎 Enlaces de interés ​

© FixBoard — Todos los derechos reservados.

© FixBoard — Todos los derechos reservados.