|[Página Inicial](home)|
|---|   

# Página de Configuração do Projeto

Aqui deve ser explicado como configurar o Ambiente para que os Desenvolvedores do Projeto possam configurar o projeto para rodar em seus computadores, deve ser sempre atualizado a cada mudança de instalação feita.

# Back End #
## Job Quest API

## Documentação
Git: https://git-scm.com/doc <br>
Node.js: https://nodejs.org/en/docs/ <br>
KnexJS: http://knexjs.org/ <br>

## Pré-requisitos
Git: https://git-scm.com/ <br>
Node.js: https://nodejs.org/en/ <br>
MySQL: https://www.mysql.com/ <br>

## Banco de Dados
schema: job_quest  <br>
usuario: root  <br>
senha: (sem senha)  <br>

```
Caso ja tenha um banco mysql configurado com alguma senha,
ajuste no arquivo knexfile.js a mesma. Ou se quiser pode
trocar a senha root do seu mysql local para nenhuma com os comandos abaixo:
ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY '';
flush privileges;
```
### Rodando MySQL com Docker (opcional)
Caso deseje rodar o banco de uma maneira mais simples, você pode fazer isso via [docker](https://www.docker.com/) seguindo os seguintes passos:
1. Instale o Docker (compatível Windows 10 Pro e distribuições Linux)
2. Rode o comando `docker container run -e MYSQL_ROOT_PASSWORD={senha} -p 3306:3306 -v /sql-data:/var/lib/mysql -d mysql`

Obs: O comando acima criará um container com o MySQL dentro dele e vai permitir conexões na porta 3306 e com um usuário chamado root. Troque *{senha}* pela senha que você deseja usar.

## Instalação
```
git clone https://tools.ages.pucrs.br/job-quest/api
cd API
git checkout dev
npm install
npm start
```

## Scripts BD
```
migrations e seeds estão inclusos no projeto, utilize:

npx knex migrate:latest -> irá gerar as tabelas
npx knex seed:run -> rodar os inserts tabelas

para dropar as tabelas, caso necessário, utilize:
npx knex migrate:down -> irá remover as tabelas

O projeto também contem os scripts para rodar manualmente:
database/banco.sql
```

## Documentação do projeto
Você pode acessar todas as apis do projeto através do swagger.
<br>
Local: (http://localhost:4000/api-docs)


## Requests (deprecated)
```
Todas as requests devem estar inclusas no arquivo
job_quest.postman_collection.json na raiz do projeto.
Instale o postman: https://www.postman.com/
Importe a coleção para dentro do postman para utilizar
e adicionar chamadas.
```


# Front End #

## Documentação

React: https://reactjs.org/docs/getting-started.html<br>
Node.js: https://nodejs.org/en/docs/<br>
Git: https://git-scm.com/doc <br>
Guia básico de Git: https://rogerdudler.github.io/git-guide/ <br>

## Pré-requisitos

Git: https://git-scm.com/ <br>
Node.js: https://nodejs.org/en/<br>

## Instalação

```
git clone https://tools.ages.pucrs.br/job-quest/WEB
cd WEB
git checkout dev
npm/yarn install
npm/yarn start
```

## Storybook

Storybook é uma lib que permite visualizar isoladamente os componentes desenvolvidos.

Para executar basta rodar o comando abaixo:

```
npm/yarn storybook
```

## Bibliotecas Auxiliares P/ Desenvolvimento

Gerenciador de Estados mobX -> https://mobx.js.org/README.html <br>
Componentes Estilizados -> https://styled-components.com/ <br>
Material UI -> https://material-ui.com/pt/ <br>
Axios HTTP Requests -> https://github.com/axios/axios <br>
Storybook -> https://storybook.js.org/ <br>