... | ... | @@ -18,10 +18,18 @@ git clone http://tools.ages.pucrs.br/radar-do-investidor/radardoinvestidor-front |
|
|
$ 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
|
... | ... | @@ -29,5 +37,33 @@ git clone http://tools.ages.pucrs.br/radar-do-investidor/backend.git |
|
|
2. Entrar no diretório do projeto:
|
|
|
```
|
|
|
$ cd backend
|
|
|
$ docker-compose -d up
|
|
|
$ 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/
|
|
|
``` |