Skip to main content

Configuración del entorno

Esta guía describe los pasos para preparar tu entorno local y comenzar a trabajar con (apolo-app-platcom-platform).

1. Clonar e Instalar dependencias​

# Clonar el repositorio
git clone https://github.com/Cencosud-xlabs/apolo-app-platcom-platform.git
cd apolo-app-platcom-platform

# Instalar dependencias
npm install

2. Autenticación de GitHub Packages​

Este repositorio usa paquetes privados del scope @Cencosud-xlabs publicados en GitHub Packages.

Crear un Personal Access Token:

  1. Ve a GitHub Settings → Developer settings → Personal access tokens
  2. Genera un nuevo token con permiso read:packages
  3. Copia el token

Configurar autenticación:

# Exportar token en tu shell
export GITHUB_TOKEN=<tu_token>

# Opcional: Persistir en tu perfil de shell
echo 'export GITHUB_TOKEN=<tu_token>' >> ~/.zshrc && source ~/.zshrc
# O para bash:
echo 'export GITHUB_TOKEN=<tu_token>' >> ~/.bashrc && source ~/.bashrc

Verificar acceso:

npm whoami --registry=https://npm.pkg.github.com
npm view @Cencosud-xlabs/security-crypto version --registry=https://npm.pkg.github.com

Si los comandos anteriores devuelven error de autenticación (401), revisa el valor de GITHUB_TOKEN

3. Archivos de entorno y secretos​

La gestión de secretos y variables de entorno se realiza a través de Seki y el archivo config/.secretsrc.json.

La generación de secretos se explica en detalle en: 👉 Secretos y variables de entorno

4. Infraestructura local con Docker​

Para levantar las dependencias locales (MongoDB, Redis, Kafka / Redpanda, etc.):

docker compose up -d

Esto levantará:

  • MongoDB
  • Redis
  • Kafka (Redpanda)
  • Redpanda Console (UI para inspeccionar tópicos y mensajes)

Más detalles sobre servicios, puertos y conexión en: 👉 Entorno Docker

5. Ejecutar servicios de la plataforma​

Ejemplos de servicios definidos en el monorepo (vía Nx):

# Servicios Backend
npx nx serve bff-api            # Backend para Frontend
npx nx serve applications-api   # Servicio de aplicaciones
npx nx serve auth-api           # Servicio para autenticación
npx nx serve core-api           # Servicio core
npx nx serve reports-api        # Servicio de reportes
npx nx serve tenants-api        # Servicio de tenants

# Frontend
npx nx serve portal-web         # Portal Web de auditoría

# Documentación
npx nx serve devs-portal        # Docusaurus (documentación)

# Playground
npx nx serve playground-library # Playground de la librería

Revisa la sección Workspace Nx Workspace Nx para entender mejor cómo se organizan estos proyectos.