--- title: Configuração Local description: "O guia para contribuidores (ou desenvolvedores curiosos) que desejam executar o Twenty localmente." image: /images/user-guide/fields/field.png --- Header ## Pré-requisitos Antes de instalar e usar o Twenty, certifique-se de instalar o seguinte em seu computador: - [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) - [Node v24.5.0](https://nodejs.org/en/download) - [yarn v4](https://yarnpkg.com/getting-started/install) - [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md) `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. 1. Instalar WSL Abra o PowerShell como Administrador e execute: ```powershell wsl --install ``` Agora você deve ver um prompt para reiniciar seu computador. Caso contrário, reinicie manualmente. Ao reiniciar, uma janela do PowerShell se abrirá e instalará o Ubuntu. Isso pode levar algum tempo. Você verá um prompt para criar um nome de usuário e senha para a instalação do Ubuntu. 2. Instalar e configurar o git ```bash sudo apt-get install git git config --global user.name "Your Name" git config --global user.email "youremail@domain.com" ``` 3. Instale nvm, node.js e yarn Use `nvm` para instalar a versão correta do `node`. O `.nvmrc` garante que todos os contribuintes usem a mesma versão. ```bash sudo apt-get install curl curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash ``` Feche e reabra o terminal para usar o nvm. Em seguida, execute os seguintes comandos. ```bash nvm install # installs recommended node version nvm use # use recommended node version corepack enable ``` --- ## Passo 1: Git Clone No seu terminal, execute o seguinte comando. Se você ainda não configurou as chaves SSH, você pode aprender como fazer isso [aqui](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh). ```bash git clone git@github.com:twentyhq/twenty.git ``` ```bash git clone https://github.com/twentyhq/twenty.git ``` ## Passo 2: Posicione-se na raiz ```bash 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 **Option 1 (preferred):** To provision your database locally: Use the following link to install Postgresql on your Linux machine: [Postgresql Installation](https://www.postgresql.org/download/linux/) ```bash 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 ``` ```` **Option 1 (preferred):** To provision your database locally with `brew`: ```` ```bash 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;" ``` You can verify if the PostgreSQL server is running by executing: ```bash brew services list ``` The installer might not create the `postgres` user by default when installing via Homebrew on MacOS. Instead, it creates a PostgreSQL role that matches your macOS username (e.g., "john"). To check and create the `postgres` user if necessary, follow these steps: ```bash # Connect to PostgreSQL psql postgres or psql -U $(whoami) -d postgres ``` Once at the psql prompt (postgres=#), run: ```bash # List existing PostgreSQL roles \du ``` You'll see output similar to: ```bash Role name | Attributes | Member of -----------+-------------+----------- john | Superuser | {} ``` If you do not see a `postgres` role listed, proceed to the next step. Create the `postgres` role manually: ```bash CREATE ROLE postgres WITH SUPERUSER LOGIN; ``` This creates a superuser role named `postgres` with login access. **Option 2:** If you have docker installed: ```bash make postgres-on-docker ``` ```` All the following steps are to be run in the WSL terminal (within your virtual machine) ```` **Option 1:** To provision your Postgresql locally: Use the following link to install Postgresql on your Linux virtual machine: [Postgresql Installation](https://www.postgresql.org/download/linux/) ```bash 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: Running Docker on WSL adds an extra layer of complexity. Only use this option if you are comfortable with the extra steps involved, including turning on [Docker Desktop WSL2](https://docs.docker.com/desktop/wsl). ```bash make postgres-on-docker ``` ```` Agora você pode acessar o banco de dados em [localhost:5432](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. **Option 1:** To provision your Redis locally: Use the following link to install Redis on your Linux machine: [Redis Installation](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-linux/) ```` **Option 2:** If you have docker installed: ```bash make redis-on-docker ``` ```` **Option 1 (preferred):** To provision your Redis locally with `brew`: ```bash brew install redis ``` Start your redis server: ```brew services start redis``` ```` **Option 2:** If you have docker installed: ```bash make redis-on-docker ``` ```` **Option 1:** To provision your Redis locally: Use the following link to install Redis on your Linux virtual machine: [Redis Installation](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-linux/) ```` **Option 2:** If you have docker installed: ```bash make redis-on-docker ``` ```` Se você precisar de um Cliente GUI, recomendamos o [redis insight](https://redis.io/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](https://docs.twenty.com/l/pt/developers/self-hosting/setup) Copie os arquivos `.env.example` em `/front` e `/server`: ```bash 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: ```bash yarn ``` Note que `npm` ou `pnpm` não funcionarão ## Passo 7: Executando o projeto Dependendo da sua distribuição Linux, o servidor Redis pode ser iniciado automaticamente. Caso contrário, verifique o [guia de instalação do Redis](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/) para sua distro. Redis já deve estar em execução. Redis já deve estar em execução. If not, run: ```bash brew services start redis ``` Dependendo da sua distribuição Linux, o servidor Redis pode ser iniciado automaticamente. Caso contrário, verifique o [guia de instalação do Redis](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/) para sua distro. Configure o seu banco de dados com o seguinte comando: ```bash npx nx database:reset twenty-server ``` Start the server, the worker and the frontend services: ```bash 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: ```bash npx nx start ``` ## Step 8: Use Twenty **Frontend** O frontend do Twenty estará rodando em [http://localhost:3001](http://localhost:3001). Você pode acessar com a conta demo padrão: `tim@apple.dev` (senha: `tim@apple.dev`) **Backend** - O servidor do Twenty estará operando em [http://localhost:3000](http://localhost:3000) - A API GraphQL pode ser acessada em [http://localhost:3000/graphql](http://localhost:3000/graphql) - A API REST pode ser alcançada em [http://localhost:3000/rest](http://localhost:3000/rest) ## Resolução de Problemas Se você encontrar qualquer problema, verifique [Resolução de Problemas](https://docs.twenty.com/l/pt/developers/self-hosting/troubleshooting) para soluções.