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.
Pré-requisitos
Linux e macOS
Windows (WSL)
Antes de instalar e usar o Twenty, certifique-se de instalar o seguinte em seu computador:npm não funcionará, você deve usar yarn em vez disso. O Yarn agora vem com o Node.js, então você não precisa instalá-lo separadamente.
Você só precisa executar corepack enable para habilitar o Yarn, se ainda não o fez.
- Instale o WSL
Abra o PowerShell como Administrador e execute:
Você deve agora ver um aviso para reiniciar o computador. Caso contrário, reinicie-o manualmente.Ao reiniciar, uma janela do PowerShell será aberta e instalará o Ubuntu. Isso pode levar algum tempo.
Você verá uma solicitação para criar um nome de usuário e senha para sua instalação do Ubuntu.
- Instalar e configurar o git
sudo apt-get install git
git config --global user.name "Your Name"
git config --global user.email "youremail@domain.com"
- Instale nvm, node.js e yarn
Use nvm para instalar a versão correta do node. O .nvmrc garante que todos os contribuidores usem a mesma versão.
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
No seu terminal, execute o seguinte comando.
Se ainda não configurou as chaves SSH, você pode aprender como fazê-lo aqui.git clone git@github.com:twentyhq/twenty.git
git clone https://github.com/twentyhq/twenty.git
Passo 2: Posicione-se na raiz
Você deve executar todos os comandos nas etapas seguintes a partir da raiz do projeto.
Passo 3: Configurar um Banco de Dados PostgreSQL
Linux
Mac OS
Windows (WSL)
Opção 1 (preferencial): Para provisionar seu banco de dados localmente:
Use o seguinte link para instalar o PostgreSQL na sua máquina Linux: Instalação do PostgreSQL psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
sudo -u postgres ao comando antes de psql para evitar erros de permissão.Opção 2: Se você tem o docker instalado: make -C packages/twenty-docker postgres-on-docker
Opção 1 (preferencial): Para prover seu banco de dados localmente com 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 padrão ao instalar
via Homebrew no macOS. Em vez disso, ele cria uma função PostgreSQL que corresponde ao seu nome de usuário do macOS
(por exemplo, “john”).
Para verificar e criar o usuário postgres, se necessário, siga estas etapas: # 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, prossiga para a próxima etapa.
Crie o papel postgres manualmente: CREATE ROLE postgres WITH SUPERUSER LOGIN;
postgres com acesso de login.Nome do papel | Atributos | Membro de
-----------+-------------+-----------
postgres | Superusuário | {}
john | Superusuário | {}
make -C packages/twenty-docker postgres-on-docker
Todos os passos a seguir devem ser executados no terminal WSL (dentro da sua máquina virtual)Opção 1: Para provisionar seu PostgreSQL localmente:
Use o seguinte link para instalar o PostgreSQL na sua máquina virtual Linux: Instalação do PostgreSQL psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
sudo -u postgres ao comando antes de psql para evitar erros de permissão.Opção 2: Se você tem o docker instalado:
Executar o Docker no WSL adiciona uma camada extra de complexidade.
Use esta opção apenas se estiver confortável com as etapas adicionais envolvidas, incluindo a ativação do Docker Desktop WSL2. make -C packages/twenty-docker postgres-on-docker
localhost:5432.
Se você usou a opção do Docker acima, as credenciais padrão são usuário postgres e senha postgres. Para instalações nativas do PostgreSQL, use as credenciais e os papéis configurados na sua máquina.
Passo 4: Configurar um Banco de Dados Redis (cache)
O Twenty requer um cache Redis para oferecer o melhor desempenho.
Linux
Mac OS
Windows (WSL)
Opção 1: Para prover seu Redis localmente:
Use o seguinte link para instalar o Redis na sua máquina Linux: Instalação do RedisOpção 2: Se você tem o docker instalado: make -C packages/twenty-docker redis-on-docker
Opção 1 (preferencial): Para prover seu Redis localmente com brew:Inicie o servidor Redis:brew services start redis
make -C packages/twenty-docker redis-on-docker
Opção 1: Para prover seu Redis localmente:
Use o seguinte link para instalar o Redis na sua máquina virtual Linux: Instalação do RedisOpção 2: Se você tem o docker instalado: make -C packages/twenty-docker redis-on-docker
Passo 5: Configurar variáveis de ambiente
Use variáveis de ambiente ou arquivos .env para configurar seu projeto. Mais informações aqui.
Copie os arquivos .env.example em /front e /server:
cp ./packages/twenty-front/.env.example ./packages/twenty-front/.env
cp ./packages/twenty-server/.env.example ./packages/twenty-server/.env
Modo Multiworkspace: Por padrão, o Twenty é executado no modo de workspace único, em que apenas um workspace pode ser criado. Para ativar o suporte a multiworkspace (útil para testar recursos baseados em subdomínio), defina IS_MULTIWORKSPACE_ENABLED=true no arquivo .env do seu servidor. Veja Modo Multiworkspace para obter detalhes. Passo 6: Instalando dependências
Para compilar o servidor Twenty e popular seu banco de dados com alguns dados, execute o seguinte comando:
Note que npm ou pnpm não funcionarão
Passo 7: Executando o projeto
Linux
Mac OS
Windows (WSL)
Dependendo da sua distribuição Linux, o servidor Redis pode ser iniciado automaticamente.
Se não, verifique o guia de instalação do Redis para sua distro. Redis já deve estar em execução. Se não, execute:brew services start redis
Dependendo da sua distribuição Linux, o servidor Redis pode ser iniciado automaticamente.
Se não, verifique o guia de instalação do Redis para sua distro. npx nx database:reset twenty-server
npx nx start twenty-server
npx nx worker twenty-server
npx nx start twenty-front
Passo 8: Use Twenty
Frontend
O frontend do Twenty estará em execução em http://localhost:3001.
Você pode fazer login usando a conta demo padrão: tim@apple.dev (senha: tim@apple.dev)
Backend
Resolução de Problemas
Se encontrar algum problema, verifique Resolução de Problemas para soluções.