Inicio rápido

Esta guía te ayudará a configurar tu entorno de desarrollo y a ejecutar la aplicación en minutos.

Prerrequisitos

Antes de comenzar, asegúrate de tener lo siguiente instalado en tu sistema basado en UNIX (Linux o macOS):

• Node.js: v24.x o superior (utiliza fnm o nvm para gestionar versiones)
• pnpm: v10.26.2. Cómo instalar.
• Docker: Necesario para la base de datos local y servicios. Cómo instalar.

Lynx está diseñado para sistemas UNIX. Se recomienda a los usuarios de Windows utilizar WSL2.

Instalación

1. Clonar el repositorio:

   git clone https://github.com/pablousx/lynx.git
   cd lynx

2. Instalar dependencias:

   pnpm install

Configuración

1. Iniciar servicios de backend: Lynx inicia una instancia local de PostgreSQL utilizando Docker. Ejecuta el siguiente comando para iniciar los servicios de backend:

   pnpm dev:backend

   Mantén esta ventana de terminal abierta o ejecútala en segundo plano.

2. Ejecutar configuración inicial: Este script maneja configuraciones de git, migraciones de base de datos y siembras:

   pnpm setup

   Después de este paso, puedes finalizar el proceso de servicios de backend.

Ejecutar la aplicación

Una vez completada la configuración, puedes iniciar el servidor de desarrollo:

pnpm dev

Abre http://localhost en tu navegador para ver la aplicación.

El dominio localhost personalizado solo funcionará si ejecutas la app usando pnpm dev, que también ejecuta Caddy como proxy inverso. Alternativamente, si ejecutas:

pnpm dev:frontend

puedes acceder a la app en http://localhost:3000.

Próximos pasos

Ahora que estás en funcionamiento, explora los siguientes recursos:

• Tech Stack: Aprende sobre las tecnologías que impulsan Lynx.
• Scripts: Aprende sobre los scripts disponibles para desarrollo y mantenimiento.
• Modules: Descubre las características y módulos principales.