Saltar para o conteúdo principal
Header

​
Pré-requisitos

  • Linux and 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 é fornecido 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 tiver feito isso.

​
Passo 1: Git Clone

No seu terminal, execute o seguinte comando.

​
Passo 2: Posicione-se na raiz

cd twenty
Você deve executar todos os comandos nas etapas a seguir a partir da raiz do projeto.

​
Passo 3: Configurar um Banco de Dados PostgreSQL

  • Linux
  • Mac OS
  • Windows (WSL)
Option 1 (preferred): To provision your database locally: Use the following link to install Postgresql on your Linux machine: Postgresql Installation
  psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
Note: You might need to add sudo -u postgres to the command before psql to avoid permission errors.
**Option 2:** If you have docker installed:
```bash
  make postgres-on-docker
```
Agora você pode acessar o banco de dados em localhost:5432, com usuário postgres e senha postgres.

​
Passo 4: Configurar um Banco de Dados Redis (cache)

Twenty requer um cache redis para fornecer o melhor desempenho.
  • Linux
  • Mac OS
  • Windows (WSL)
Option 1: To provision your Redis locally: Use the following link to install Redis on your Linux machine: Redis Installation
**Option 2:** If you have docker installed:
```bash
  make redis-on-docker
```
Se você precisar de um Cliente GUI, recomendamos o redis insight (versão gratuita disponível)

​
Step 5: Setup environment variables

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

​
Passo 6: Instalando dependências

Para compilar o servidor Twenty e inserir alguns dados em seu banco de dados, execute o seguinte comando: 
yarn
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. Caso contrário, verifique o guia de instalação do Redis para sua distro.
Configure o seu banco de dados com o seguinte comando: 
npx nx database:reset twenty-server
Start the server, the worker and the frontend services: 
npx nx start twenty-server
npx nx worker twenty-server
npx nx start twenty-front
Alternativamente, você pode iniciar todos os serviços de uma vez: 
npx nx start

​
Step 8: Use Twenty

Frontend O frontend do Twenty estará rodando em http://localhost:3001. Você pode acessar com a conta demo padrão: tim@apple.dev (senha: tim@apple.dev) Backend

​
Resolução de Problemas

Se você encontrar qualquer problema, verifique Resolução de Problemas para soluções.