|
|
| [Home](home) | [**Escopo**](escopo) | [Processo](processo) | [Design/Mockups](design_mockups) | [Gerência](gerencia) | [Estudos](estudos) | [Arquitetura](arquitetura) | [Contratos](contratos) | [BD](banco_dados) | [Qualidade](qualidade) | [Configuração](configuracao) | [Instalação](instalacao) | [Instruções](instrucoes) | [Utilização](utilizacao) | [Analytics](Analytics) |
|
|
|
| :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: |
|
|
|
|
|
|
# Configurações do Projeto
|
|
|
|
|
|
Esta seção apresentará todas as configurações para executar o projeto. Aqui serão encontradas as instruções de configuração de ambos ambientes para desenvolver no projeto CP-Planta.
|
|
|
|
|
|
## Sumário
|
|
|
|
|
|
- [Passo a Passo para configurar o projeto](#Passo a Passo para configurar o projeto)
|
|
|
- [Backend](#Backend)
|
|
|
- [Frontend](#Frontend)
|
|
|
- [Banco de dados](#Banco de dados)
|
|
|
|
|
|
|
|
|
|
|
|
### Passo a Passo para configurar o projeto
|
|
|
|
|
|
1. Você deve garantir que tem [NodeJS](https://nodejs.org/en/) instalado na máquina. Para verificar a versão atual do seu `NodeJs` instalado digite no terminal o comando: `node --version` ou `node -v`. Caso não tenha instalado siga o passo a passo deste [`link`](https://nodejs.org/en/download/).
|
|
|
1. Após instalar o node o `NPM` será instalado na sequência. Para verificar a versão atual do NPM digite no terminal o comando: `npm --version` ou `npm -v`. Para mais informações de NPM acesse: https://www.npmjs.com/get-npm.
|
|
|
1. Com Node JS e NPM instalados, você vai acessar a pasta raiz do projeto [Backend](#backend) / [Frontend](#frontend) e digitar o comando `npm install` para instalar as dependências do projeto. Para mais informações referentes a download e instalação de Node e NPM acesse: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm.
|
|
|
1. Para rodar o projeto digite no terminal o comando `npm start`(front) `npm run dev` (back). Automaticamente vai abrir uma aba do seu navegador com o projeto rodando.
|
|
|
|
|
|
* Frontend: http://localhost:3001
|
|
|
* Backend: http://localhost:3000
|
|
|
|
|
|
### Backend
|
|
|
|
|
|
O código-fonte do backend da aplicação está disponível [neste repositório](https://tools.ages.pucrs.br/cp-planta/backend)
|
|
|
|
|
|
Você deve clonar o projeto pelo terminal/Git Bash pelo comando `git clone http://tools.ages.pucrs.br/cp-planta/backend.git`
|
|
|
|
|
|
|
|
|
### Frontend
|
|
|
|
|
|
O Frontend da aplicação foi desenvolvido em Nextjs e seu código-fonte está disponível [neste repositório](https://tools.ages.pucrs.br/cp-planta/frontend)
|
|
|
|
|
|
Você deve clonar o projeto pelo terminal/Git Bash pelo comando `git clone http://tools.ages.pucrs.br/cp-planta/frontend.git`
|
|
|
|
|
|
## Banco de dados
|
|
|
|
|
|
### PostgreSQL
|
|
|
|
|
|
Você deve fazer download do [PostgreSQL](https://www.postgresql.org/download/) para o gerenciamento de bancos de dados.
|
|
|
Para facilitar a interação junto ao PostgreSQL, junto com o sgdb será instalado o PgAdmin 4, que é uma ferramenta de administração e desenvolvimento de banco de dados que facilita a interação com o sgdb. Caso não tenha instalado, pode instalar o [PgAdmin 4](https://www.pgadmin.org/download/) separadamente.
|
|
|
Para consultas simples, você pode utilizar o componente do Prisma, acessando no browser pelo comando `prisma studio`.
|
|
|
|
|
|
As especificações de variáveis de ambientes já estão incluídas no arquivo .env presente na raíz do projeto.
|
|
|
|
|
|
### Postman/ Insomnia
|
|
|
|
|
|
Para testes e validações da API [Download Postman](https://www.postman.com/). [Dúvidas de instalação](https://www.youtube.com/watch?v=MCPdfuzmyxY).
|
|
|
Download do [Insomnia](https://insomnia.rest/download)
|
|
|
|
|
|
---
|
|
|
[**Topo**](#configurações-do-projeto) |
|
|
\ No newline at end of file |