Configuração do Ambiente

Home	Escopo e Cronograma	Processo	Design/Mockups	Configuração	Arquitetura	Infra	Código	BD

Este guia explica como configurar o ambiente para rodar o projeto em todos os seus repositórios.

Frontend

Configuração do VS Code

Para executar o Frontend do projeto, é necessário instalar:

Após a instalação do Node.js, verifique se ele foi instalado corretamente executando o seguinte comando no terminal:

node -v

Backend

Configuração do Ambiente Backend

Requisitos

Certifique-se de ter as seguintes ferramentas instaladas na sua máquina:

Verifique se tudo foi instalado corretamente:

node -v
yarn -v
docker -v
git --version

Instalação

Clone o repositório e acesse a pasta do projeto:

git clone https://tools.ages.pucrs.br/lobo-guara/backend.git
cd backend

Instale as dependências:

yarn install

Banco de Dados

Suba o container do banco de dados com Docker Compose:

docker-compose up -d

Variáveis de Ambiente

Crie um arquivo .env na raiz do projeto com o seguinte conteúdo:

DATABASE_URL="postgresql://admin:admin@localhost:5432/lobo_guara?schema=public"
SECRET_KEY="secret-key"
JWT_SECRET="jwt-secret"

MAILERSEND_API_KEY="mailersend-api-key"
MAILERSEND_FROM_EMAIL="mailersend-from-email"

BUCKET_ACCESS_KEY_ID="bucket-access-key-id"
BUCKET_SECREAT_ACCESS_KEY="bucket-access-key"
BUCKET_NAME="bucket-name"
BUCKET_REGION="bucket-region"

ℹ️ Consulte a equipe para obter os valores reais de SECRET_KEY, JWT_SECRET, MAILERSEND_API_KEY e configurações do bucket.

Migrações

Rode as migrações do banco de dados:

yarn prisma migrate deploy

Execução

Para iniciar a aplicação em modo de desenvolvimento:

yarn start:dev

A API estará disponível em:

Swagger: http://localhost:3000/docs
Base URL: http://localhost:3000

Parando os Containers

Para parar os containers do banco de dados:

docker-compose stop