... | ... | @@ -30,44 +30,89 @@ Aqui serão encontradas as instruções de configuração de ambos ambientes de |
|
|
|
|
|
#### Instalação
|
|
|
|
|
|
TBD
|
|
|
Esta aplicação é uma API desenvolvida em Node. Para conseguir rodá-la corretamente você precisa ter o NodeJS instalado na sua máquina. Para isso, vá até o site https://nodejs.org/en/ e baixe a versão LTS (a versão estável mais atualizada).
|
|
|
|
|
|
#### Verificação
|
|
|
|
|
|
TBD
|
|
|
##### Rodando o lint
|
|
|
|
|
|
O lint é uma ferramenta que checa algumas regras de convenção de código assim como formatação, para manter o padrão entre os desenvolvedores do time e manter um código consistente nesses padrões. O comando para rodar o lint é `flutter analyze` para o frontend e `npm run lint` no ambiente backend
|
|
|
|
|
|
|
|
|
### Configurando a IDE
|
|
|
|
|
|
TBD
|
|
|
Aqui vai uma lista de extensões para se ter no VSCode e melhorar a experiência no desenvolvimento do projeto. A lista está separada por extensões obrigatórias (não ter essa extensão vai dificultar sua contribuição no projeto) e opcionais (não precisa ter, mas facilita um pouquinho a vida).
|
|
|
|
|
|
- obrigatórias:
|
|
|
- editorconfig
|
|
|
- eslint
|
|
|
- Flutter
|
|
|
- Dart
|
|
|
- prettier
|
|
|
- recomendadas
|
|
|
- code spell checker
|
|
|
- Better Comments
|
|
|
- CodeMetrics
|
|
|
- IntelliCode
|
|
|
- Live Share
|
|
|
- Jest
|
|
|
- NestJS Files
|
|
|
- gitlens
|
|
|
- Rainbow Brackets
|
|
|
|
|
|
### Clonando os Repositórios
|
|
|
|
|
|
TBD
|
|
|
|
|
|
## Backend
|
|
|
|
|
|
### Configurando a Máquina
|
|
|
|
|
|
TBD
|
|
|
Tendo o node instalado, clone o projeto em uma pasta local de sua preferência através do comando `git clone https://tools.ages.pucrs.br/idoso-mais/idoso-mais-backend.git` (para isso você precisa do [git](https://git-scm.com/) instalado também).
|
|
|
|
|
|
### Compilando
|
|
|
Antes de tudo você precisa criar suas variáveis de ambiente. Para isso, crie um arquivo chamado `.env.development` na raiz do projeto seguindo o modelo do `.env.template`. Preencha as informações de acordo com seus ambiente, se tiver alguma dúvida é só chamar algum colega pra checar.
|
|
|
|
|
|
TBD
|
|
|
Utilizamos o MongoDB como banco de dados do projeto. Para rodar o setup local completo, instale o MongoDB local seguindo os passos do link https://www.mongodb.com/docs/manual/administration/install-community/ de acordo com a sua máquina. Após ter o banco instalado e rodando local, baixe o MongoDB Compass https://www.mongodb.com/docs/compass/master/install/ para acessar sua instalação local e ver o seu banco de dados local através de uma interface amigável.
|
|
|
|
|
|
### Executando
|
|
|
Nota: a porta onde o MongoDB for instalado deve ser a porta utilizada na string de conexão `DB_CONNECTION` no arquivo .env.development da sua máquina.
|
|
|
|
|
|
TBD
|
|
|
### Executando
|
|
|
|
|
|
Após criar o .env.development, abra um terminal na pasta do projeto e rode o comando `npm install`. Após finalizado, rode `npm run start:dev`. O ambiente de desenvolvimento do Nest deve iniciar e você deve ver o log de ações que ele realizou em verde e amarelo em seu terminal.
|
|
|
|
|
|
## Frontend
|
|
|
|
|
|
### Configurando a Máquina
|
|
|
|
|
|
TBD
|
|
|
Nosso projeto frontend será feito com [Flutter](https://docs.flutter.dev/get-started/install). Após realizado o download do .zip, deve extraí-lo e também, é necessário adicionar o caminho do bin dentro das variáveis de ambiente.
|
|
|
|
|
|
### Compilando
|
|
|
- Windows:
|
|
|
|
|
|
TBD
|
|
|
Sugestão de caminho onde extrair: `C:\src\` com o nome "flutter`.
|
|
|
|
|
|
### Executando
|
|
|
Sugestão de caminho das variáveis de ambiente: `C:\src\flutter\bin`.
|
|
|
|
|
|
- MacOS ou Linux:
|
|
|
|
|
|
TBD |
|
|
Sugestão de caminho onde extrair: `~/development`.
|
|
|
|
|
|
Rodar o comando para ajusta as variáveis de ambiente: `export PATH="$PATH:<caminho>/flutter/bin"`.
|
|
|
|
|
|
Após a configuração das variáveis será possível utilizar o `flutter doctor`, nele conseguimos ver se há alguma dependência das plataformas faltando.
|
|
|
|
|
|
Tendo o flutter instalado, clone o projeto em uma pasta local de sua preferência através do comando `git clone https://tools.ages.pucrs.br/idoso-mais/idoso-mais-frontend.git` (para isso você precisa do [git](https://git-scm.com/) instalado também).
|
|
|
|
|
|
#### Configuração do VSCode
|
|
|
|
|
|
Aqui vai uma sugestão de configuração do seu vscode, acesse o "help > show all comands" e selecione o "Preferences: Open User settings" `settings.json` e adicione:
|
|
|
```
|
|
|
"[dart]": {
|
|
|
"editor.codeActionsOnSave": {
|
|
|
"source.fixAll": true
|
|
|
},
|
|
|
"editor.defaultFormatter": "Dart-Code.dart-code",
|
|
|
"editor.formatOnSave": true,
|
|
|
},
|
|
|
```
|
|
|
|
|
|
### Executando
|
|
|
|
|
|
Para rodar o projeto, primeiro é necessário rodar o comando `flutter pub get` ele serve para poder baixar todas as dependências do projeto, após finalizar rode o `flutter run` e escolha o dispositivo aonde deseja rodar, outra opção, é utilizar o botão `run` acima do método "main". |