API responsável por prover os dados que serão consumidos pela aplicação front-end da Findy.
-
O back-end da aplicação utiliza o banco de dados MySQL. É essencial que você tenha em sua máquina o MySQL instalado ou tenha um container (Docker) com a instância do MySQL configurado, ou ainda um banco de dados MySQL em nuvem configurado. Dentro da pasta
findy.backend
existe um arquivo.env.example
que deve ser renomeado para.env
e na variável de nome "DATABASE_URL" deve ser inserido o endereço (URL) do banco, seja local ou na nuvem. -
Ex. de URL local: "mysql://root:12345678@localhost:3306/findy_db"
- root => trata-se do usuário, nesse caso, o usuário é o "root", usuário raiz do MySQL. Se você não criou um usuário, provavelmente é o root que está configurado.
- 12345678 => senha do banco. Use a senha que você registrou para o banco.
- localhost => IP de acesso. Localmente, esse é o IP padrão que se usa.
- 3306 => porta; Se não mapear outra porta, essa é a padrão.
- findy_db => nome do banco. É bom manter esse nome mesmo.
-
Para facilitar, existe um "Docker compose criado dentro do diretório do back-end" que cria o container (Docker) do MySQL com as configurações padrão, que a URL de exemplo utiliza.
-
Para rodar o compose:
npm run compose:up
- Para parar o compose:
npm run compose:down
- Clone o repositório, entre na pasta do projeto
findy.backend
. - Depois de clonar o repositório, você precisa das variáveis de ambientes que configuram vários acessos da aplicação. Seguem abaixo as orientações:
- Você deve acessar a documentação de como configurar as variáveis de ambientes que o projeto utiliza neste link Doc, na coluna "Orientações para Equipes" e o card "Deploy / Development / QA".
$ npm install
# development
$ npx prisma generate
# development
$ npx prisma migrate dev --name init
# development
$ npm run dev:seed
# development
$ npm run start
# watch mode - development
$ npm run start:dev
## Documentação da API (Swagger)
```bash
# development: Para visualizar a documentação da API em desenvolvimento utilize:
$ http://localhost:3001/api
Se ainda não ficou muito claro segue um link onde encontra o guia com mais detalhes:
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
- Autores -
Vania Ioott |
Rafael Santos |
Jéssica Santana |
Emerson Moreira |
Findy licenciado pelo MIT.