✨ feat: api de estacionamentos 1.0.0

.env.example

@@ -0,0 +1,5 @@
+DATABASE_HOST=localhost
+DATABASE_PORT=3306
+DATABASE_USERNAME=usuarioDB 
+DATABASE_PASSWORD=senhaDB
+DATABASE_NAME=nomeDB

.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir : __dirname, 
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

.gitignore

@@ -0,0 +1,36 @@
+# compiled output
+/dist
+/node_modules
+
+.env
+
+# Logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

.vscode/settings.json

@@ -0,0 +1,22 @@
+{
+  "workbench.colorCustomizations": {
+    "activityBar.activeBackground": "#ab307e",
+    "activityBar.activeBorder": "#25320e",
+    "activityBar.background": "#ab307e",
+    "activityBar.foreground": "#e7e7e7",
+    "activityBar.inactiveForeground": "#e7e7e799",
+    "activityBarBadge.background": "#25320e",
+    "activityBarBadge.foreground": "#e7e7e7",
+    "sash.hoverBorder": "#ab307e",
+    "statusBar.background": "#832561",
+    "statusBar.foreground": "#e7e7e7",
+    "statusBarItem.hoverBackground": "#ab307e",
+    "statusBarItem.remoteBackground": "#832561",
+    "statusBarItem.remoteForeground": "#e7e7e7",
+    "titleBar.activeBackground": "#832561",
+    "titleBar.activeForeground": "#e7e7e7",
+    "titleBar.inactiveBackground": "#83256199",
+    "titleBar.inactiveForeground": "#e7e7e799"
+  },
+  "peacock.color": "#832561"
+}

README.md

@@ -1,58 +1,63 @@
-### FCamara 🚀
-*"Queremos ser como uma árvore, 
-  crescer um pouco todos os dias e tentar tocar o céu, 
-  sem perder a solidez de nossas raízes."*
-Conheça: www.fcamara.com.br
 
-## Teste para vaga de Desenvolvedor Back-end
-Criar uma API REST para gerenciar um estacionamento de carros e motos.
+# Estacionamento de Veículos com Nestjs e Mysql
 
-## Cadastro de estabelecimento
+API construída para teste de desenvolvedor fullstack para o cliente Dr. Consulta
 
-Criar um cadastro da empresa com os seguintes campos:
-- Nome;
-- CNPJ;
-- Endereço;
-- Telefone;
-- Quantidade de vagas para motos;
-- Quantidade de vagas para carros.
-
-**Todos** os campos são de preenchimento obrigatório.
-
-## Cadastro de veículos
-
-Criar um cadastro de veículos com os seguintes campos:
-- Marca;
-- Modelo;
-- Cor;
-- Placa;
-- Tipo.
-
-**Todos** os campos são de preenchimento obrigatório.
+## Objetivo do Projeto
+Permitir registro de entradas e saídas de veículos em estabelecimentos.
 
 ## Funcionalidades
-
-   - **Estabelecimento:** CRUD;
-   - **Veículos:** CRUD;
-   - **Controle de entrada e saída de veículos.**
-
-## Requisitos
-
-   - Modelagem de dados;
-   - O retorno deverá ser em formato JSON e XML;
-   - Requisições GET, POST, PUT ou DELETE, conforme a melhor prática;
-   - A persistência dos dados pode ser realizada da maneira que preferir;
-   - Criar README do projeto descrevendo as tecnologias utilizadas, chamadas dos serviços e configurações necessário para executar a aplicação.
-
-## Ganha mais pontos
-   - Desenvolver utilizando TDD;
-   - Criar API de relatório;
-   - Sumário da quantidade de entrada e saída;
-   - Sumário da quantidade de entrada e saída de veículos por hora;
-   - Criar uma solução de autenticação.
-
-## Submissão
-Crie um fork do teste para acompanharmos o seu desenvolvimento através dos seus commits.
-
-## Obrigado!
-Agradecemos sua participação no teste. Boa sorte! 😄
+- [x]  Estabelecimentos (Listagem, Cadastro, alteração, atualização, deleção)
+- [x]  Veículos (Listagem, Cadastro, alteração, atualização, deleção)
+- [x]  Log de eventos (Registro, listagem)
+
+## Tecnologias utilizadas
+* Framework Nodejs - <a href="https://nestjs.com/" about="_blank">Nestjs 8.0.0</a>
+* Banco de dados - <a href="https://dev.mysql.com/downloads/mysql/8.0.html" about="_blank">Mysql 8.0.0</a>
+* ORM - <a href="https://www.npmjs.com/package/typeorm" about="_blank">TypeORM 5.2.1</a>
+* TypeScript - <a href="https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-3.html" about="_blank">4.3.5</a>
+* Documentação - <a href="https://www.npmjs.com/package/@nestjs/swagger?activeTab=versions" about="_blank">Nest Swagger 5.2.1</a>
+
+### Pré-requisitos
+
+Você vai precisar ter instalado em sua máquina as seguintes ferramentas:
+* [Git](https://git-scm.com)
+* [Node.js](https://nodejs.org/en/).
+* [Mysql](https://dev.mysql.com/downloads/installer/)
+* [Mysql WorkBench (Criar banco de dados)](https://www.jetbrains.com/datagrip/download/?source=google&medium=cpc&campaign=15034928143&term=mysql%20gui&gclid=CjwKCAjwjtOTBhAvEiwASG4bCANtIirgdt1u0tE2VS4tCyx4oxSvZtIiAjDYLfaYSPp7Uf91JIgOwBoCrVUQAvD_BwE#section=windows)
+* [Insomnia (Testar requisições)](https://insomnia.rest/download)
+
+Arquivos Úteis: 
+* [Collection de exemplo para o insomnia](https://drive.google.com/file/d/1LgeC3i8azuCdpRIIeiA5wpROx7VmiT6g/view?usp=sharing)
+* [Modelagem inicial do banco(rascunho)](https://drive.google.com/file/d/18H3V6Mwued1fftxeePxtz_nPAFtwUgJy/view?usp=sharing)
+* [Script que comecei fazendo na mão :c](https://drive.google.com/file/d/12QlQwfOMN9PzXm88faEiakvKyRscKULa/view?usp=sharing)
+* [Modelagem final do banco rsrs :E](https://drive.google.com/file/d/1awDnBSJrtl83N9f16Ek11oHj_BlPctqY/view?usp=sharing)
+
+### 🎲 Rodando o back-end (api)
+
+#### Certifique-se de já estar com o mysql local rodando na porta 3306, banco de dados local para teste criado, e informações como "database, host, username e password" em mãos.
+
+```bash
+# Clone este repositório
+$ git clone <https://github.com/carlosgizbert/backend-test-jest>
+
+# Acesse a pasta do projeto no terminal/cmd
+$ cd backend-test-jest
+
+# Instale as dependências
+$ npm install
+
+# Acesse a pasta de configuração do banco de dados Mysql
+$ cd /src/data/database.providers.ts
+altere os valores para o seu banco de dados local
+      username: 'nome_banco_mysql_local',
+      password: 'senha_banco_mysql_local',
+      database: 'nome_banco_mysql_local',
+
+# Execute a aplicação em modo de desenvolvimento
+$ npm run start:dev
+Após isso, a aplicação irá montar as tabelas no banco de dados local de forma automática, e você já poderá utilizar a api em sua máquina.
+
+# O servidor inciará na porta:3000 e a página inicial será a documentação do swagger explicando as rotas e propriedades.
+* Acesse <http://localhost:3000>.
+```

nest-cli.json

@@ -0,0 +1,9 @@
+{
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "assets": [
+      "common/envs/*"
+    ]
+  }
+}