Página de Configuração do Projeto

Aqui deve ser explicado como configurar o Ambiente para que os Desenvolvedores do Projeto possam configurar o projeto para rodar em seus computadores, deve ser sempre atualizado a cada mudança de instalação feita.

• Deve ser explicado a configuração de TODAS as partes do projeto, tanto BACK,BANCO,FRONT,etc...
• Além de explicar aqui, deve ter em cada Repositório o RESUMO de como instalar para quando os Desenvolvedores baixarem o projeto possam configurar por lá também

Como rodar o Frontend do projeto

1. Clonar o projeto:

git clone http://tools.ages.pucrs.br/radar-do-investidor/radardoinvestidor-frontend.git

2. Entrar no diretório do projeto:

$ cd radardoinvestidor-frontend
$ npm install
$ npm run dev

3. Arquivo .env.local:

Adicionar um arquivo na raiz do projeto com o nome ".env.local".
O arquivo deve ter como conteúdo:
$ NEXT_PUBLIC_API_URL=https://api.radar.warren.com.br/api

Como rodar o Backend do projeto

O projeto está organizado em containers. Para rodar o projeto em ambiente de desenvolvimento:

1. Clonar o projeto:

git clone http://tools.ages.pucrs.br/radar-do-investidor/backend.git

2. Entrar no diretório do projeto:

$ cd backend
$ docker-compose -f docker-compose.yaml up

3. Quando terminar de utilizar o container

$ docker-compose down -v

O comando "-v" garante que o docker vai apagar o volume criado pelo container, caso esqueça de utilizar o "-v" basta utilizar o seguinte comando para apagar volumes que não estão sendo utilizados:

$ docker volume prune

4. Arquivo .env:

Adicionar um arquivo na raiz do projeto com o nome ".env".
O arquivo deve ter como conteúdo:
$ DATABASE_URL="postgresql://<db_username>:<db_passowrd>@postgres:5432/<db_name>"
$ API_KEY="<api_key>"

Swagger

Depois de executar o programa, basta acessar a seguinte URL para ver o swagger com a explicação de todas as rotas disponibilizadas pela API:

localhost:4000/doc/