Files
app-padel/docs
Ivan Alcaraz 80ef062789
Some checks failed
CI/CD Pipeline / 🧪 Tests (push) Has been cancelled
CI/CD Pipeline / 🏗️ Build (push) Has been cancelled
CI/CD Pipeline / 🚀 Deploy to Staging (push) Has been cancelled
CI/CD Pipeline / 🚀 Deploy to Production (push) Has been cancelled
CI/CD Pipeline / 🏷️ Create Release (push) Has been cancelled
CI/CD Pipeline / 🧹 Cleanup (push) Has been cancelled
Maintenance Tasks / 💾 Database Backup (push) Has been cancelled
Maintenance Tasks / 🧹 Cleanup (push) Has been cancelled
Maintenance Tasks / 🔒 Security Scan (push) Has been cancelled
Maintenance Tasks / 🏥 Health Check (push) Has been cancelled
📄 docs: Agregar documentación final del proyecto completo
2026-01-31 22:32:53 +00:00
..

📚 Documentación - App Canchas de Pádel

Bienvenido a la documentación oficial de App Canchas de Pádel.


📖 Índice de Documentos

📘 Documentación Principal

Documento Descripción
API.md Documentación completa de la API REST con todos los endpoints, autenticación, y ejemplos
SETUP.md Guía paso a paso para configurar el entorno de desarrollo
DEPLOY.md Guía completa para deployar en producción (VPS, PM2, Nginx, SSL)
ARCHITECTURE.md Arquitectura del sistema, diagramas y patrones de diseño

📱 Documentación Comercial

Documento Descripción
APP_STORE.md Material para publicación en App Store y Google Play

📋 Otros Documentos

Documento Descripción
CHANGELOG.md Historial de cambios y versiones
postman-collection.json Colección de Postman con todos los endpoints

🚀 Empezar Rápidamente

Para Desarrolladores

  1. Configurar entorno local:

    # Ver guía completa en SETUP.md
    cd backend && npm install && npm run dev
    
  2. Explorar la API:

    # Documentación en API.md
    # Importar postman-collection.json en Postman
    
  3. Entender la arquitectura:

    # Leer ARCHITECTURE.md
    

Para DevOps

  1. Deployar en producción:

    # Ver guía completa en DEPLOY.md
    ./scripts/deploy.sh production
    
  2. Configurar monitoreo:

    pm2 monit
    

📊 Resumen de la API

  • Base URL: https://api.tudominio.com/api/v1
  • Autenticación: JWT (JSON Web Tokens)
  • Formato: JSON
  • Total Endpoints: 150+

Módulos Principales

Módulo Endpoints Descripción
Auth 5 Registro, login, tokens
Users 6 Gestión de usuarios
Courts 6 Canchas y disponibilidad
Bookings 8 Reservas de canchas
Matches 5 Registro de partidos
Tournaments 11 Torneos e inscripciones
Leagues 12 Ligas por equipos
Ranking 5 Sistema de rankings
Payments 8 Pagos con MercadoPago
Subscriptions 14 Suscripciones/membresías
Friends 7 Sistema social
Notifications 7 Notificaciones push
Analytics 18 Reportes y dashboard
Extras 20+ Logros, Wall of Fame, etc.

🏗️ Stack Tecnológico

Backend

  • Runtime: Node.js 20.x
  • Framework: Express.js 4.x
  • Lenguaje: TypeScript 5.x
  • ORM: Prisma 5.x
  • Base de Datos: PostgreSQL 16.x
  • Autenticación: JWT (jsonwebtoken)
  • Validación: Zod
  • Logs: Winston
  • Procesos: PM2

Frontend

  • Framework: React 18.x
  • Build Tool: Vite
  • Estilos: Tailwind CSS

Mobile

  • Framework: React Native
  • Navigation: React Navigation

Infraestructura

  • Servidor: Ubuntu 24.04 LTS
  • Web Server: Nginx
  • SSL: Let's Encrypt
  • Container: Docker (opcional)

🔗 Enlaces Útiles


📞 Soporte

¿Necesitas ayuda?

  1. Revisa la documentación específica del módulo
  2. Consulta los ejemplos en API.md
  3. Contacta al equipo: soporte@tudominio.com

Última actualización: Enero 2026