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
  • Compilando
  • Executando
• Frontend
  • Configurando a Máquina
  • Compilando
  • Executando
• Banco de Dados
  • Configurando o Banco de Dados
• Deploy

Configurações Gerais

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

Instalando o Node

Instalação

Instalando o NVM:

# instala de nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash

Instalando o node 18:

# instala node 18
nvm install 18

Instalando o yarn:

#instala o yarn
npm i -g yarn

Verificação

Validar a instalação:

#verifica a versão do Node instalada
node -v

Configurando a IDE

Estamos utilizando a IDE chamada VS Code (Visual Studio Code) para desenvolvimento. Ela pode ser baixada pelo link: VS Code Download.

Estamos utilizando as configurações padrões da IDE, apenas é necessário instalar as extensões:

• Yarn
• Prettier
• ESLint
• Prisma

Para isto, basta abrir o painel de Extenções com Ctrl + Shift + x, pesquisar pela extensão desejada, e fazer a instalação.

Clonando os Repositórios

backend

git clone https://tools.ages.pucrs.br/projeto-rivi/rivi-backend-node.git

frontend

git clone https://tools.ages.pucrs.br/projeto-rivi/rivi-frontend-js.git

Backend

Configurando a Máquina

Realizada as instalações e configurações previamente citadas, e fazendo o uso do Visual Studio Code. A máquina está pronta para o desenvolvimento do backend.

Compilando

yarn

Executando

yarn run dev

Entre em http://localhost:4000 para visualizar a aplicação.

Entre em http://localhost:4000/api-docs para visualizar a documentação.

Frontend

Configurando a Máquina

Realizada as instalações e configurações previamente citadas, e fazendo o uso do Visual Studio Code. A máquina está pronta para o desenvolvimento do frontend.

Compilando

yarn

Executando

yarn run dev

Entre em http://localhost:3000 para visualizar a aplicação.

Banco de Dados

Configurando o Banco de Dados

Neste projeto, optamos por usar o banco de dados MongoDB. Para mais informações sobre o banco de dados, acesse o tópico Banco de Dados.

Neste projeto, não utilizamos um banco local para o desenvolvimento, decidimos utilizar o MongoDB Atlas. Um serviço de nuvem onde o banco de dados permanece em constante disponibilidade, basta configurar o MongoDB Atlas de forma online, desta forma, dispensa a instalação de um banco de dados no sistema.

Para configurar o MongoDB Atlas, é preciso:

1. Criar uma conta no sistema do MongoDB Atlas.
2. Criar um Cluster, dentro do sistema online.
3. Configurar os Acessos de Rede do banco de dados.
4. Se conectar ao banco de dados.

Para isto, sugerimos seguir o tutorial do próprio MongoDB através deste link: MongoDB Atlas Tutorial Oficial.

Também há um vídeo explicativo de como configurar corretamente o banco de dados utilizando o MongoDB Atlas, seguindo este link: Configuração do MongoDB Atlas.

Quando o MongoDB Atlas estiver configurado no projeto do backend, é preciso passar a chave de acesso do banco para o arquivo .env do projeto.

Lembrando, uma vez criado o banco, ele não possuirá dados. É necessário criar os dados através da aplicação para que tenham dados no banco de dados. Em etapa de desenvolvimento, fizemos o uso do Swagger no projeto do backend, que pode auxiliar nesta etapa. Para mais detalhes, acesse o tópico Procedimentos.

Deploy

Backend

• Railway: https://railway.app/
  • Usuário: [email protected]
  • Senha: Rivi@2022/2
• Documentação no Swagger: https://railway.app/api-docs

Frontend

• Vercel: https://rivi-frontend-js.vercel.app/
  • Usuário: [email protected]
  • Senha: Rivi@2022/2

Recipes API

TBD

Diagrama de Deploy

TBD