Introducción a Yuruary
Bienvenido a la documentación técnica de Yuruary, la plataforma SaaS Híbrida para la administración de condominios.
Esta documentación está diseñada para guiar a los desarrolladores y arquitectos a través del ecosistema de Yuruary, desde la arquitectura offline-first hasta la referencia de la API.
¿Qué es Yuruary?
Yuruary es un sistema de gestión que combina lo mejor de dos mundos:
- Fiabilidad On-Premise: Un núcleo administrativo que funciona localmente en la oficina del condominio, garantizando operación continua incluso sin internet.
- Accesibilidad en la Nube: Un portal web para residentes alojado en AWS, permitiendo consultas y pagos 24/7.
El sistema utiliza un Cloudflare Tunnel y colas de sincronización para mantener la consistencia entre el servidor local y la nube sin exponer puertos inseguros.
Estructura de la Documentación
Explora los siguientes módulos para profundizar:
- Arquitectura: Detalles sobre el monolito modular, NestJS, Electron y la sincronización.
- Base de Datos: Esquemas de PostgreSQL y estrategias de replicación.
- API Reference: Endpoints REST para el portal de residentes y comunicacion interna.
- Guía de Despliegue: Instrucciones para desplegar en AWS y configurar el servidor local.
Primeros Pasos
Si eres nuevo en el proyecto, te recomendamos comenzar por la Visión General de Arquitectura para entender cómo fluyen los datos entre la nube y la oficina.
Este proyecto utiliza Domain-Driven Design (DDD). Asegúrate de familiarizarte con los Bounded Contexts antes de contribuir al código del backend.