Ejecuta Northstack en local

Abre cada terminal donde esperan los comandos de abajo: dentro de northstack-full-stack para el full stack, o junto a la carpeta de la aplicación para el paquete Backend API.

Abre la terminal junto a la carpeta de la aplicación, donde extrajiste el ZIP.

Inicia primero la API: el panel lee de ella todos sus datos, y el formulario de contacto y el pago de licencias del sitio web la llaman.

Inicia la API

1. 01

   Instala y configura

   .env.example funciona tal cual en tu propio equipo: SQLite en ./database.sqlite, la API en el puerto 8000, y el sitio web (http://localhost:3030) y el panel (http://localhost:3031) con permiso para llamarla.

   TerminalCopiar

   corepack enable
   cd back-end
   yarn install
   cp .env.example .env

   0:00 / 0:13

   ¿Tienes problemas?

   Ya hice este paso
2. 02

   Crea la base de datos

   yarn seed crea database.sqlite y sus tablas, los roles y ajustes de la plataforma, el espacio de trabajo de ejemplo Forma Studio (12 proyectos con sus tableros, 8 miembros, 2 invitaciones, una suscripción Pro con tres facturas, una clave de API, la actividad de las últimas semanas y tres conversaciones con el asistente), un segundo espacio de trabajo para su propietario, y 732 organizaciones detrás de las cifras de la plataforma. Termina mostrando las cuentas con las que iniciar sesión. Las fechas siguen el día en que cargas los datos. Si lo ejecutas de nuevo sobre una base de datos que ya tiene cuentas, no añade ninguna cuenta ni espacio de trabajo y devuelve sus permisos a los roles de plataforma integrados.

   Terminalen back-endCopiar

   yarn seed

   Ya hice este paso
3. 03

   Inicia el servidor

   Terminalen back-endCopiar

   yarn dev

   Resultado esperado: localhost:8000/api/healthLocal responde con "status":"ok" y "database":"up".

   ¿Tienes problemas?

   Ya hice este paso

Inicia la API

1. 01

   Instala y configura

   .env.example funciona tal cual en tu propio equipo: SQLite en ./database.sqlite, la API en el puerto 8000, y el sitio web (http://localhost:3030) y el panel (http://localhost:3031) con permiso para llamarla.

   TerminalCopiar

   corepack enable
   cd northstack-backend
   yarn install
   cp .env.example .env

   0:00 / 0:13

   ¿Tienes problemas?

   Ya hice este paso
2. 02

   Crea la base de datos

   yarn seed crea database.sqlite y sus tablas, los roles y ajustes de la plataforma, el espacio de trabajo de ejemplo Forma Studio (12 proyectos con sus tableros, 8 miembros, 2 invitaciones, una suscripción Pro con tres facturas, una clave de API, la actividad de las últimas semanas y tres conversaciones con el asistente), un segundo espacio de trabajo para su propietario, y 732 organizaciones detrás de las cifras de la plataforma. Termina mostrando las cuentas con las que iniciar sesión. Las fechas siguen el día en que cargas los datos. Si lo ejecutas de nuevo sobre una base de datos que ya tiene cuentas, no añade ninguna cuenta ni espacio de trabajo y devuelve sus permisos a los roles de plataforma integrados.

   Terminalen northstack-backendCopiar

   yarn seed

   Ya hice este paso
3. 03

   Inicia el servidor

   Terminalen northstack-backendCopiar

   yarn dev

   Resultado esperado: localhost:8000/api/healthLocal responde con "status":"ok" y "database":"up".

   ¿Tienes problemas?

   Ya hice este paso

Todas las cuentas de ejemplo inician sesión con la contraseña NorthstackDemo26!: owner@northstack.example, admin@northstack.example, member@northstack.example, billing@northstack.example, platform@northstack.example y support@northstack.example.

Inicia el panel de espacios de trabajo

En una segunda terminal:

1. 01

   Instala y configura

   El .env copiado apunta el panel a la API en el puerto 8000 y sus actualizaciones de permisos en vivo al mismo servidor.

   TerminalCopiar

   cd dashboard
   yarn install
   cp .env.example .env

   0:00 / 0:09

   Ya hice este paso
2. 02

   Inícialo e inicia sesión

   Terminalen dashboardCopiar

   yarn dev

   Resultado esperado: localhost:3031Local abre el formulario de inicio de sesión. Inicia sesión con owner@northstack.example y la contraseña NorthstackDemo26!.

   ¿Tienes problemas?

   Ya hice este paso

Inicia el panel de espacios de trabajo

La API no forma parte de este paquete. Por sí solo, el panel funciona con sus datos de ejemplo integrados: inícialo sin un archivo .env.

1. 01

   Instálalo e inícialo con datos de ejemplo

   Sin .env, NEXT_PUBLIC_API_BASE_URL está vacío y cada pantalla responde con los datos de ejemplo en tu navegador.

   TerminalCopiar

   corepack enable
   cd northstack-dashboard
   yarn install
   yarn dev

   0:00 / 0:21

   Resultado esperado: localhost:3031Local abre el formulario de inicio de sesión con un aviso de datos de ejemplo al final. Entra cualquier contraseña: owner@northstack.example abre el espacio de trabajo del propietario, y cada correo de ejemplo abre su rol.

   ¿Tienes problemas?

   Ya hice este paso
2. 02

   Conéctalo a la API

   Con la API de Northstack en marcha en http://localhost:8000/api, detén yarn dev, copia los ajustes de ejemplo e inícialo de nuevo. Si tu API funciona en otra parte, define NEXT_PUBLIC_API_BASE_URL (con /api) y NEXT_PUBLIC_WEBSOCKET_BASE_URL (sin ella) en .env con su dirección.

   Terminalen northstack-dashboardCopiar

   cp .env.example .env
   yarn dev

   Resultado esperado: Inicia sesión con owner@northstack.example y la contraseña NorthstackDemo26!, que acepta una API con datos de ejemplo. El aviso de datos de ejemplo desaparece.

   ¿Tienes problemas?

   Ya hice este paso

Inicia el sitio web público

En una tercera terminal:

1. 01

   Instala y configura

   Cada valor del .env copiado es opcional: apunta el sitio web a la API en el puerto 8000 y al panel en el 3031.

   TerminalCopiar

   cd website
   yarn install
   cp .env.example .env

   0:00 / 0:09

   Ya hice este paso
2. 02

   Inícialo

   Terminalen websiteCopiar

   yarn dev

   Resultado esperado: localhost:3030Local abre el sitio web en inglés; el árabe está en /ar.

   ¿Tienes problemas?

   Ya hice este paso

Inicia el sitio web público

La API no forma parte de este paquete. Por sí solo, el sitio web funciona con sus datos de ejemplo integrados: inícialo sin un archivo .env.

1. 01

   Instálalo e inícialo con datos de ejemplo

   Sin .env, NEXT_PUBLIC_API_BASE_URL está vacío: el formulario de contacto y el pago de licencias responden en tu navegador y no envían nada.

   TerminalCopiar

   corepack enable
   cd northstack-website
   yarn install
   yarn dev

   0:00 / 0:17

   Resultado esperado: localhost:3030Local abre el sitio web con un aviso de datos de ejemplo al final de cada página; el árabe está en /ar.

   ¿Tienes problemas?

   Ya hice este paso
2. 02

   Conéctalo a la API

   Con la API de Northstack en marcha en http://localhost:8000/api, detén yarn dev, copia los ajustes de ejemplo e inícialo de nuevo. Si tu API funciona en otra parte, define NEXT_PUBLIC_API_BASE_URL en .env con su dirección, incluido /api.

   Terminalen northstack-websiteCopiar

   cp .env.example .env
   yarn dev

   Resultado esperado: El aviso de datos de ejemplo desaparece, y el formulario de contacto y el pago llegan a tu API.

   ¿Tienes problemas?

   Ya hice este paso

Otros puertos

Sin Docker, los puertos se definen en los archivos. Los scripts dev y start del sitio web en package.json pasan -p 3030; para otro puerto ejecuta yarn next dev -p 3040 (o yarn next start -p 3040 tras yarn build). El panel lee PORT de su .env (PORT=3041), y arranca en el 3031 sin él. Con la API, añade la dirección de un frontend movido al CORS_ORIGIN del .env de la API, y defínela allí como WEBSITE_URL para el sitio web, o como DASHBOARD_URL y FRONTEND_URL para el panel; define el propio NEXT_PUBLIC_SITE_URL o NEXT_PUBLIC_BASE_URL del frontend para que coincida. Para mover la API, define PORT, PUBLIC_API_URL y PUBLIC_MEDIA_URL en su .env con el mismo número, y NEXT_PUBLIC_API_BASE_URL en ambos frontends (también el NEXT_PUBLIC_WEBSOCKET_BASE_URL del panel).

• Un puerto ya está en uso

Versión de producción

Las mismas carpetas, construidas una vez y luego iniciadas. Primero configura el .env de la API para producción: con NODE_ENV=production la API nunca cambia las tablas al iniciar, y se niega a iniciar mientras JWT_SECRET esté vacío o siga con el valor de ejemplo, o mientras CORS_ORIGIN esté vacío.

NODE_ENV=production
JWT_SECRET=paste-the-generated-secret-here
CORS_ORIGIN=http://localhost:3030,http://localhost:3031
FRONTEND_URL=http://localhost:3031
DASHBOARD_URL=http://localhost:3031
WEBSITE_URL=http://localhost:3030
PUBLIC_API_URL=http://localhost:8000
PUBLIC_MEDIA_URL=http://localhost:8000/media

Genera el secreto con node -e "console.log(require('crypto').randomBytes(48).toString('hex'))". Luego, en la carpeta de la API, constrúyela, crea sus tablas una vez con los datos de ejemplo e iníciala. yarn seed:prod es el yarn seed compilado.

yarn build
yarn seed:prod
yarn start:prod

• Despliégalo

Construcción de producción de los frontends

En la carpeta de cada frontend, detén yarn dev, construye una vez e inicia. El sitio web sirve en el 3030 y el panel en el 3031.

yarn build
yarn start

Los frontends compilan sus valores NEXT_PUBLIC_* en el momento de la construcción, así que ejecuta yarn build de nuevo tras cambiar .env. Antes de desplegar en cualquier sitio público, lee la guía de despliegue.

• Despliégalo

Empieza de cero con datos de demostración nuevos

Detén la API, elimina el archivo de la base de datos y vuelve a cargar los datos, en la carpeta de la API. Esto elimina todo lo que creaste.

rm -f database.sqlite* && yarn seed

En PowerShell:

Remove-Item database.sqlite*; yarn seed

yarn reset vacía todas las tablas y las conserva, y yarn drop elimina todas las tablas; ejecuta yarn seed después de cualquiera de los dos para llenar de nuevo la base de datos. En MySQL, donde no hay un archivo que borrar, empieza de nuevo con:

yarn reset
yarn seed

Comandos

Siguiente

• Configura tus variables de entorno
• Ejecútalo con Docker en su lugar
• Soluciona un problema de instalación