Configurações do Projeto

Descrição

Esta seção apresentará todas as configurações para executar o projeto.

Sumário

• Configurações Gerais
  • Instalando o Node
  • Configurando sua IDE
  • Clonando os Repositórios
• Backend
  • Configurando a Máquina
  • Preparando Para Executar
  • Executando
• Frontend
  • Configurando a Máquina
  • Preparando Para Executar
  • Executando

Configurações Gerais

Aqui serão encontradas as instruções de configuração de ambos ambientes de desenvolvimento.

Instalando o Node

Node.js é a única ferramenta que precisaremos instalar para rodar o projeto. O download do instalador do Node pode ser realizado pelo seguinte link.

Faça o download e siga os passos de instalação da versão mais recente que possua LTS (Long Term Support).

Para verificar se o node foi instalado corretamente, execute o comando node -v e verifique se o retorno é semelhante ao apresentado abaixo (caso a versão seja diferente não se preocupe).

node -v
v14.16.0

Configurando a IDE

O projeto foi desenvolvido com VSCode. Você pode utilizar outras IDEs, mas nesta sessão, abordaremos apenas para o VSCode.
Você pode baixar o instalador do VSCode pelo seguinte link.
O VSCode possui diversas extensões, mas nenhuma é obrigatória para rodar o projeto.

Clonando os Repositórios

Para clonar os repositórios, siga os seguintes passos:

1. Abra o terminal;
2. Navegue até a pasta em que deseja salvar os repositórios;
3. Utilize o comando: "git clone https://tools.ages.pucrs.br/denuncia-a-violencia/backend.git" para clonar o repositório do backend;
4. Navegue de volta para a pasta em que deseja salvar os repositórios;
5. Utilize o comando: "git clone https://tools.ages.pucrs.br/denuncia-a-violencia/frontend.git" para clonar o repositório do frontend;

Backend

Configurando a Máquina

O Node.js, abordado na sessão Instalando o Node, é a única dependência necessária para executar a aplicação do backend.

Preparando Para Executar

Para poder executar a aplicação, são necessários apenas 4 passos:

1. Abrir o VSCode na pasta do backend;
2. Abrir um terminal no VSCode, na pasta do backend;
3. Rodar o comando "npm install" no terminal;
4. Possuir o .env preenchendo os seguintes atributos (consultar algum AGES III ou IV da equipe para conseguir os dados):
   AWS_ACCESS_KEY_ID=
   AWS_SECRET_ACCESS_KEY=
   AWS_DEFAULT_REGION=
   ENVIRONMENT=
   LOCAL_PRIVATE_KEY=
   PRODUCTION_PRIVATE_KEY=
   

Executando

Para executar, rode o comando "npm run dev" e aguarde a aparição de "Server is running" no seu terminal. Após "Server is running" aparecer, abra o seu browser e visite a URL http://localhost:3333/api-docs/, para visualizar a documentação da api. Caso ocorra algum erro relacionado a "token inválido", vá para o arquivo "app.ts" e comente a linha "this.server.use(verifyIdToken)" TEMPORARIAMENTE (descomentar depois de realizar as tarefas que você precisava fazer sem o frontend ativo).

Frontend

Configurando a Máquina

O Node.js, abordado na sessão Instalando o Node, é a única dependência necessária para executar a aplicação do frontend.

Preparando Para Executar

Para poder executar a aplicação, são necessários apenas 4 passos:

1. Abrir o VSCode na pasta do frontend;
2. Abrir um terminal no VSCode, na pasta do frontend;
3. Rodar o comando "npm install" no terminal;
4. Possuir o .env preenchendo os seguintes atributos (consultar algum AGES III ou IV da equipe para conseguir os dados):
   REACT_APP_API_KEY=
   REACT_APP_AUTH_DOMAIN=
   REACT_APP_PROJECT_ID=
   REACT_APP_STORAGE_BUCKET=
   REACT_APP_MESSAGING_SENDER_ID=
   REACT_APP_APP_ID=
   REACT_APP_API_URL=
   

Executando

ATENÇÃO: É necessário executar o backend antes de executar o frontend, caso contrário, a aplicação não conseguirá funcionar adequadamente.
Para executar, apenas rode o comando "npm start" e a aplicação abrirá no seu browser padrão.