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 Educa Mais
Sumário
Passo a Passo para configurar o projeto
- Você deve garantir que tem NodeJS instalado na máquina. Para verificar a versão atual do seu
NodeJs
instalado digite no terminal o comando:node --version
ounode -v
. Caso não tenha instalado siga o passo a passo destelink
. - 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
ounpm -v
. Para mais informações de NPM acesse: https://www.npmjs.com/get-npm. - Com Node JS e NPM instalados, você vai acessar a pasta raiz do projeto Backend / Frontend
Configuração do Front End
Opção 1 - NPM
Ao clonar o projeto você deve rodar o comando npm i
para dar um install em todos os arquivos, rotas e imports do projeto.
Após isso ele vai te dar dois comandos:
npm i -g serve
serve -s build
IMPORTANTE: O segundo comando (serve -s build
) deve ser rodado em um terminal do tipo cmd
e não no powershel
padrão do VSCode. Se ele buildar corretamente pode dar um ctrl + c
ou apenas fechar este terminal e iniciar um novo.
Ao ter certeza que o build anterior funcionou você irá rodar o comando npm run build
e terminar instalar as dependências e buildar, se o mesmo funcionar corretamente, pode dar um ctrl + C
ou iniciar um novo terminal para continuar o passo a passo.
Agora precisa instalar o node-sass, então rode o comando no terminal:
npm i node-sass
instalado o node é preciso que você vá até o arquivo package.json
e adicione duas linhas a ele.
Em "dependencies" do JSON, você vai adicionar abaixo da linha 12 o comando:
"sass": "node-sass -watch css -o sass",
OBS: IMPORTANTE: não apague NADA, apenas adicione o que é solicitado na documentação.
Agora você vai adicionar no "Script" do JSON o comando:
"sass": "sass src/styles/scss:src/styles/css -w --no-source-map",
Agora importante rodar o comando:
npm i -g sass
para terminar de instalar as alterações feitas no projeto.
Opção 2 - YARN
Ao clonar o projeto você deve rodar o comando yarn install
para dar um install em todos os arquivos, rotas e imports do projeto.
Rodar o Projeto
Front end
Para rodar o projeto você deve rodar dois terminais, um deles você irá rodar o comando
npm run sass
Esse comando deve ser rodado para que o sass entenda que deve buildar todo o arquivo com o css e o mesmo estar compilando perfeitamente. O outro terminal deve rodar o comando normal para rodar o projeto npm start
(front)
Back End
- Inicialmente, certifique-se que você possui o docker instalado, caso contrário siga as instruções (https://docs.docker.com/engine/install/)
Abra o terminal de sua preferência e insira o comando:
- docker-compose up
Pronto, agora em sua máquina estará rodando dois serviços, o Adminer e o MySQL.
Para acessar o adminer (interface para visualização dos dados do banco):
Para acessar o MySQL:
Backend
O código-fonte do backend da aplicação está disponível neste repositório
Você deve clonar o projeto pelo terminal/Git Bash pelo comando git clone http://tools.ages.pucrs.br/educa-mais/educa-mais-backend.git
Frontend
O Frontend da aplicação foi desenvolvido em React e seu código-fonte está disponível neste repositório
Você deve clonar o projeto pelo terminal/Git Bash pelo comando git clone http://tools.ages.pucrs.br/educa-mais/educa-mais-frontend.git
Banco de dados
MySQL/Adminer
Para acessar o banco de dados, utilize o Adminer (interface para visualização do banco de dados mySQL), que está localizado no http://localhost:8080.
Credenciais de Acesso no Adminer
- System: MySQL
- server: srv-mysql-soc
- db:
- user: saude
- passwd: saude123
- database:
Postman
Para testes e validações da API Download. Dúvidas de instalação