Começando

Pré-requisitos

Antes de fazer a configuração inicial, você precisa ter 2 runtimes instalados:

• NodeJS versão 20 ou superior
• Bun versão 1.1.3 ou superior

Apesar do Bun ser o runtime principal, uma das dependências (Prisma) ainda precisa do Node para gerar os arquivos iniciais.

Dica

Caso já tenha o Node instalado, você pode o bun via npm:

npm install -g bun@1.1.3

Configuração

Você pode tanto fazer um fork deste projeto quanto cloná-lo, fica a seu critério.

Agora, o primeiro passo é instalar as dependências do projeto:

bun install

Rodando o servidor

O projeto está configurado como um monorepo (ou workspace) usando uma ferramenta chamada turbo repo.

Isso significa que para rodar o servidor através da raiz do projeto, você precisa rodar:

bun run dev --filter=taco-api

Esse comando vai gerar os arquivos necessarios e iniciar o servidor HTTP da API no endereço http://localhost:4000/graphql

Rodando o servidor com Docker

Caso queira um ambiente totalmente configurado sem precisar instalar nada, é possível rodar o projeto via docker.

Para isso, na raiz do projeto, rode o comando:

docker-compose -f ./apps/api/docker-compose.yml up

Nota

O docker-compose está configurado para rodar a API em modo de desenvolvimento. Para fazer o deploy como uma imagem docker, acesse a seção Deploy > Docker

Rodando a documentação

Caso queira editar a documentação, na raíz do projeto rode o comando:

bun run dev --filter=website