Documentation Index
Fetch the complete documentation index at: https://docs.twenty.com/llms.txt
Use this file to discover all available pages before exploring further.
Prerrequisitos
Linux y MacOS
Windows (WSL)
Antes de que puedas instalar y usar Twenty, asegúrate de instalar lo siguiente en tu computadora:npm no funcionará, deberías usar yarn en su lugar. Yarn ahora se envía con Node.js, por lo que no necesitas instalarlo por separado.
Solo tienes que ejecutar corepack enable para habilitar Yarn si aún no lo has hecho.
- Instalar WSL
Abre PowerShell como Administrador y ejecuta:
Ahora deberías ver un aviso para reiniciar tu computadora. Si no, reiníciala manualmente.Al reiniciar, se abrirá una ventana de PowerShell e instalará Ubuntu. Esto puede tomar algo de tiempo.
Verás un aviso para crear un nombre de usuario y contraseña para tu instalación de Ubuntu.
- Instalar y configurar git
sudo apt-get install git
git config --global user.name "Your Name"
git config --global user.email "youremail@domain.com"
- Instalar nvm, node.js y yarn
Usa nvm para instalar la versión correcta de node. El .nvmrc asegura que todos los colaboradores usen la misma versión.
sudo apt-get install curl
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
nvm install # installs recommended node version
nvm use # use recommended node version
corepack enable
Paso 1: Clonar con Git
En tu terminal, ejecuta el siguiente comando.
Si aún no has configurado claves SSH, puedes aprender cómo hacerlo aquí.git clone git@github.com:twentyhq/twenty.git
git clone https://github.com/twentyhq/twenty.git
Paso 2: Ubícate en la raíz
Debes ejecutar todos los comandos de los siguientes pasos desde la raíz del proyecto.
Paso 3: Configurar una Base de Datos PostgreSQL
Linux
Mac OS
Windows (WSL)
Opción 1 (preferido): Para aprovisionar tu base de datos localmente:
Usa el siguiente enlace para instalar PostgreSQL en tu máquina Linux: Instalación de PostgreSQL psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
sudo -u postgres antes del comando psql para evitar errores de permisos.Opción 2: Si tienes Docker instalado: make -C packages/twenty-docker postgres-on-docker
Opción 1 (preferido): Para aprovisionar tu base de datos localmente con brew: brew install postgresql@16
export PATH="/opt/homebrew/opt/postgresql@16/bin:$PATH"
brew services start postgresql@16
psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
postgres por defecto al instalar
vía Homebrew en macOS. En cambio, crea un rol de PostgreSQL que coincide con tu
nombre de usuario de macOS (por ejemplo, “john”).
Para comprobar y crear el usuario postgres si es necesario, sigue estos pasos: # Connect to PostgreSQL
psql postgres
or
psql -U $(whoami) -d postgres
# List existing PostgreSQL roles
\du
Role name | Attributes | Member of
-----------+-------------+-----------
john | Superuser | {}
postgres listado, procede al siguiente paso.
Crea el rol postgres manualmente: CREATE ROLE postgres WITH SUPERUSER LOGIN;
postgres con acceso de inicio de sesión.Nombre del rol | Atributos | Miembro de
-----------+-------------+-----------
postgres | Superuser | {}
john | Superuser | {}
make -C packages/twenty-docker postgres-on-docker
Todos los siguientes pasos deben ejecutarse en la terminal de WSL (dentro de tu máquina virtual)Opción 1: Para aprovisionar tu PostgreSQL localmente:
Usa el siguiente enlace para instalar PostgreSQL en tu máquina virtual Linux: Instalación de PostgreSQL psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
sudo -u postgres antes del comando psql para evitar errores de permisos.Opción 2: Si tienes Docker instalado:
Ejecutar Docker en WSL agrega una capa extra de complejidad.
Solo usa esta opción si estás cómodo con los pasos extras involucrados, incluyendo activar Docker Desktop WSL2. make -C packages/twenty-docker postgres-on-docker
postgres y contraseña postgres.
Paso 4: Configurar una Base de Datos Redis (cache)
Twenty requiere un caché de redis para proporcionar el mejor rendimiento
Linux
Mac OS
Windows (WSL)
Opción 1: Para aprovisionar tu Redis localmente:
Usa el siguiente enlace para instalar Redis en tu máquina Linux: Instalación de RedisOpción 2: Si tienes Docker instalado: make -C packages/twenty-docker redis-on-docker
Opción 1 (preferido): Para aprovisionar tu Redis localmente con brew:Inicia tu servidor redis:
brew services start redisOpción 2: Si tienes Docker instalado: make -C packages/twenty-docker redis-on-docker
Opción 1: Para aprovisionar tu Redis localmente:
Usa el siguiente enlace para instalar Redis en tu máquina virtual Linux: Instalación de RedisOpción 2: Si tienes Docker instalado: make -C packages/twenty-docker redis-on-docker
Paso 5: Configurar las variables de entorno
Usa variables de entorno o archivos .env para configurar tu proyecto. Más información aquí
Copia los archivos .env.example en /front y /server:
cp ./packages/twenty-front/.env.example ./packages/twenty-front/.env
cp ./packages/twenty-server/.env.example ./packages/twenty-server/.env
Modo de múltiples espacios de trabajo: De forma predeterminada, Twenty se ejecuta en modo de un solo espacio de trabajo, donde solo se puede crear un espacio de trabajo. Para habilitar la compatibilidad con múltiples espacios de trabajo (útil para probar funciones basadas en subdominios), establece IS_MULTIWORKSPACE_ENABLED=true en el archivo .env de tu servidor. Consulta Modo de múltiples espacios de trabajo para más detalles. Paso 6: Instalación de dependencias
Para compilar el servidor de Twenty e ingresar algunos datos en tu base de datos, ejecuta el siguiente comando:
Ten en cuenta que npm o pnpm no funcionarán
Paso 7: Ejecutar el proyecto
Linux
Mac OS
Windows (WSL)
Dependiendo de tu distribución de Linux, el servidor Redis podría iniciarse automáticamente.
Si no, revisa la guía de instalación de Redis para tu distribución. Redis ya debería estar funcionando. Si no, ejecuta:brew services start redis
Dependiendo de tu distribución de Linux, el servidor Redis podría iniciarse automáticamente.
Si no es así, consulte la guía de instalación de Redis para su distribución. npx nx database:reset twenty-server
npx nx start twenty-server
npx nx worker twenty-server
npx nx start twenty-front
Paso 8: Use Twenty
Frontend
El frontend de Twenty estará ejecutándose en http://localhost:3001.
Puede iniciar sesión usando la cuenta demo por defecto: tim@apple.dev (contraseña: tim@apple.dev)
Backend
Solución de Problemas
Si encuentras algún problema, consulta Solución de Problemas para ver soluciones.