Merge pull request #1 from BureauTech/dev

Entrega - Sprint 1

.gitignore

@@ -1 +1,6 @@
-./node_modules
+**/node_modules
+**/package-lock.json
+**/temp/*
+**/dist
+
+!.keep

.vscode/launch.json

@@ -0,0 +1,30 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen",
+            "name": "server",
+            "program": "${workspaceFolder}/src/server/index.js",
+            "request": "launch",
+            "restart": true,
+            "runtimeExecutable": "nodemon",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "type": "pwa-node",
+            "envFile": "${workspaceFolder}/src/server/.env"
+        },
+        {
+            "type": "chrome",
+            "request": "launch",
+            "name": "client",
+            "url": "http://localhost:3001",
+            "webRoot": "${workspaceFolder}/src/client/src",
+            "breakOnLoad": true,
+            "sourceMapPathOverrides": {
+                "webpack:///src/*": "${webRoot}/*"
+            }
+        },
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,25 @@
+{
+    "eslint.format.enable": true,
+    "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+    },
+    "eslint.validate": ["vue", "html", "javascript"],
+    "eslint.options": {
+    "extensions": [
+        ".js",
+        ".vue"
+    ]
+    },
+    "vetur.format.defaultFormatter.css": "prettier",
+    "vetur.format.defaultFormatter.js": "none",
+    "vetur.format.defaultFormatter.less": "none",
+    "vetur.format.defaultFormatter.postcss": "none",
+    "vetur.format.defaultFormatter.scss": "none",
+    "vetur.format.defaultFormatter.stylus": "none",
+    "vetur.format.defaultFormatter.ts": "none",
+    "vetur.format.defaultFormatter.html": "js-beautify-html",
+    "[vue]": {
+        "editor.defaultFormatter": "octref.vetur"
+    },
+    "files.eol": "\r\n"
+}

README.md

@@ -1 +1,180 @@
-# BureAuto
+# BureAuto
+
+<div align="center">
+  <img src="./doc/img/bureauto_sem_fundo.png" height="400" width="600"/>
+<p align="center">Plataforma de anúncios de veículos</p>
+
+Desenvolvido pela [BureauTech](https://github.com/BureauTech).
+
+</div>
+
+# Sumário
+
+   * [Sobre](#bureauto)
+   * [Sumário](#sumário)
+   * [Protótipo das telas da aplicação](#protótipo-das-telas-da-aplicação)
+   * [Entregas](#entregas)
+        * [Modelagem de Dados](#modelagem-de-dados)
+      * [Burndown](#burndown)
+      * [Backlog](#backlog)
+   * [Como executar localmente](#como-executar-localmente)
+      * [Pré-Requisitos](#pré-requisitos)
+      * [Servidor](#servidor)
+      * [Cliente](#cliente)
+   * [Testes da Aplicação](#testes-da-aplicação)
+   * [Tecnologias](#tecnologias)
+   * [Autores](#autores)
+
+## Protótipo das telas da aplicação 
+
+- Wireframe Aplicação Web
+<div align="center">
+  <img src="./doc/gif/wireframe_web.gif" />
+</div>
+
+<br>
+
+- Wireframe Aplicação Mobile
+<div align="center">
+  <img src="./doc/gif/wireframe_app.gif" />
+</div>
+
+<br>
+
+Protótipo interativo das <b>telas web</b> está disponível neste link: https://bit.ly/BureAuto
+
+Protótipo interativo das <b>telas mobile</b> está disponível neste link: https://bit.ly/BureAutoMobile
+
+<br>
+
+# Entregas
+
+- [Sprint 1](https://github.com/BureauTech/BureAuto/releases/tag/1.0.0) entrega realizada em 19/09/2021.
+
+## Entregas propostas
+
+<div align="center">
+  <img src="./doc/img/cards_bureauto.png" />
+</div>
+<br/> 
+
+## Modelagem de Dados
+- Modelo Conceitual 
+
+<div align="center">
+  <img src="./doc/img/modelo_conceitual.png" align="center" >
+ </div>
+<br/>
+
+- Modelo Lógico
+
+<div align="center">
+<img src="./doc/img/modelo_logico.png"  >
+</div>
+<br/>  
+
+## Burndown
+
+<div align="center">
+  <img src="./doc/img/burndown.png" />
+</div>
+<br/> 
+
+## Backlog 
+
+- [Product Backlog](./doc/artefatos/product_backlog_bureauto.pdf)
+
+# Como executar localmente
+
+Para executar a aplicação completa localmente, siga as intruções a seguir:
+
+### Pré-requisitos:
+
+Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:
+
+```
+NodeJS - Versão: 15.x.x
+PostgreSQL - Versão: 12.x
+VueJS - Versão 2.x
+```
+
+Além disso é bom ter um editor para trabalhar com o código como VSCode.
+
+## Servidor
+
+1. Na pasta [***src/server***](/src/server), execute os comandos abaixo: <br>
+
+```
+npm install
+npm run dev
+```
+
+Ficará disponível em [localhost:3000](http://localhost/3000)
+
+2. Execute no seu SGBD, todos os scripts SQL disponíveis na pasta [***src/server/resources***](/src/server/resources/)
+
+## Cliente
+
+Na pasta [***src/client/***](/src/client): <br>
+
+1. Faça a instalação dos módulos e execute-os:
+
+```
+npm install
+npm run dev
+```
+
+Ficará disponível em [localhost:3001](http://localhost/3001)
+
+# Testes da aplicação
+
+Para realização dos testes unitários do backend da aplicação, vá em [***src/server***](/src/server) e execute:
+
+```
+npm run test
+```
+
+# Tecnologias
+
+As seguintes ferramentas foram usadas na construção do projeto:
+
+- [NodeJS](https://nodejs.org/)
+- [PostgreSQL](https://www.postgresql.org/)
+- [VueJS](https://vuejs.org/)
+
+Bibliotecas:
+
+- [cookie-parser](https://www.npmjs.com/package/cookie-parser)
+- [cors](https://www.npmjs.com/package/cors)
+- [dotenv](https://www.npmjs.com/package/dotenv)
+- [ejs](https://www.npmjs.com/package/ejs)
+- [express](https://www.npmjs.com/package/express)
+- [express-fileupload](https://www.npmjs.com/package/express-fileupload)
+- [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken)
+- [nodemailer](https://www.npmjs.com/package/nodemailer)
+- [papaparse](https://www.npmjs.com/package/papaparse)
+- [pg](https://www.npmjs.com/package/pg)
+- [secure-random-password](https://www.npmjs.com/package/secure-random-password)
+- [typeorm](https://www.npmjs.com/package/typeorm)
+- [axios](https://www.npmjs.com/package/axios)
+- [core-js](https://www.npmjs.com/package/core-js)
+- [vue-router](https://www.npmjs.com/package/vue-router)
+- [vue-toasted](https://www.npmjs.com/package/vue-toasted)
+- [vuetify](https://www.npmjs.com/package/vuetify)
+- [vuex](https://www.npmjs.com/package/vuex)
+
+# Autores
+
+<table align="center">
+  <tr>
+    <td align="center"><a href="https://github.com/anaclaragraciano"><img src="https://avatars.githubusercontent.com/u/64653864?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ana Clara<br>PO</b></sub></a><br /><a href="https://github.com/BureauTech/BureAuto/commits?author=anaclaragraciano" title="PO">:sparkles::iphone::open_book:</a></td>
+    <td align="center"><a href="https://github.com/bibiacoutinho"><img src="https://avatars.githubusercontent.com/u/56437723?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Beatriz Coutinho<br>Master</b></sub></a><br /><a href="https://github.com/BureauTech/BureAuto/commits?author=bibiacoutinho" title="Master">:headphones::nail_care::computer_mouse:</a></td>
+    <td align="center"><a href="https://github.com/caiquesjc"><img src="https://avatars.githubusercontent.com/u/54915913?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Caique Nascimento<br>Dev</b></sub></a><br /><a href="https://github.com/BureauTech/BureAuto/commits?author=caiquesjc" title="Dev Team">:keyboard::desktop_computer::computer_mouse:</a></td>     
+</table>
+<table align="center">
+    <td align="center"><a href="https://github.com/charles-ramos"><img src="https://avatars.githubusercontent.com/u/25464287?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Charles Ramos<br>Dev</b></sub></a><br /><a href="https://github.com/BureauTech/BureAuto/commits?author=charles-ramos" title="Dev Team">:fist_raised::open_book::hamburger:</a></td>
+    <td align="center"><a href="https://github.com/danielsantosoliveira"><img src="https://avatars.githubusercontent.com/u/55162125?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Daniel Oliveira<br>Dev</b></sub></a><br /><a href="https://github.com/BureauTech/BureAuto/commits?author=danielsantosoliveira" title="Dev Team">:computer::guitar::soccer:</a></td>
+    <td align="center"><a href="https://github.com/Denis-Lima"><img src="https://avatars.githubusercontent.com/u/55518511?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Denis Lima<br>Dev</b></sub></a><br /><a href="https://github.com/BureauTech/BureAuto/commits?author=Denis-Lima" title="Dev Team">:computer::v::pizza:</a></td>
+    <td align="center"><a href="https://github.com/WeDias"><img src="https://avatars.githubusercontent.com/u/56437612?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Wesley Dias<br>Dev</b></sub></a><br /><a href="https://github.com/BureauTech/BureAuto/commits?author=WeDias" title="Dev Team">:rocket::milky_way::new_moon:</a></td>
+  </tr>
+</table>

src/client/.browserslistrc

@@ -0,0 +1,3 @@
+> 1%
+last 2 versions
+not dead

src/client/.eslintrc.js

@@ -0,0 +1,43 @@
+module.exports = {
+    env: {
+        browser: true,
+        commonjs: true,
+        es6: true,
+        node: true
+    },
+    extends: ["eslint:recommended", "plugin:vue/essential"],
+    parserOptions: {
+        ecmaVersion: 12
+    },
+    plugins: ["vue"],
+    rules: {
+        "indent": ["error", 4],
+        "quotes": ["error", "double"],
+        "semi": ["error", "never"],
+        "comma-dangle": ["error", "never"],
+        "comma-spacing": ["error", {"before": false, "after": true}],
+        "comma-style": ["error", "last"],
+        "array-bracket-newline": ["error", "never"],
+        "array-bracket-spacing": ["error", "never"],
+        "array-element-newline": ["error", "never"],
+        "func-style": ["error", "expression"],
+        "brace-style": ["warn", "1tbs", {"allowSingleLine": false}],
+        "function-call-argument-newline": ["error", "never"],
+        "function-paren-newline": ["error", "never"],
+        "implicit-arrow-linebreak": ["error", "beside"],
+        "no-var": "error",
+        "max-len": ["warn", {"code": 140, "comments": 140, "tabWidth": 4}],
+        "curly": ["warn", "multi-line", "consistent"],
+        "no-else-return": "warn",
+        "key-spacing": ["warn", {"mode": "strict"}],
+        "object-curly-spacing": ["warn", "never"],
+        "space-before-blocks": ["warn", "always"],
+        "space-in-parens": ["warn", "never"],
+        "space-before-function-paren": ["warn", "never"],
+        "require-atomic-updates": "off",
+        "no-duplicate-imports": "error",
+        "no-confusing-arrow": "error",
+        "prefer-const": "error",
+        "vue/comment-directive": 0
+    }
+}

src/client/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+    presets: ["@vue/cli-plugin-babel/preset"]
+}

src/client/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "client",
+  "version": "1.0.0",
+  "author": "BureauTech",
+  "scripts": {
+    "build": "vue-cli-service build",
+    "dev": "vue-cli-service serve --port 3001"
+  },
+  "dependencies": {
+    "axios": "^0.21.3",
+    "core-js": "^3.6.5",
+    "vue": "^2.6.14",
+    "vue-router": "^3.2.0",
+    "vue-toasted": "^1.1.28",
+    "vuetify": "^2.4.0",
+    "vuex": "^3.6.2"
+  },
+  "devDependencies": {
+    "@vue/cli-plugin-babel": "~4.5.0",
+    "@vue/cli-plugin-router": "~4.5.0",
+    "@vue/cli-service": "~4.5.0",
+    "eslint": "^7.32.0",
+    "eslint-plugin-vue": "^7.17.0",
+    "sass": "~1.32.0",
+    "sass-loader": "^10.0.0",
+    "vue-cli-plugin-vuetify": "~2.4.2",
+    "vue-template-compiler": "^2.6.11",
+    "vuetify-loader": "^1.7.0"
+  },
+  "keywords": [],
+  "license": "ISC"
+}

src/client/public/index.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width,initial-scale=1.0">
+    <link rel="icon" href="favicon.ico">
+    <title>Bureauto</title>
+    <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:100,300,400,500,700,900">
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@mdi/font@latest/css/materialdesignicons.min.css">
+    <link rel="stylesheet" href="./style.css">
+
+  </head>
+  <body>
+    <noscript>
+      <strong>
+        We're sorry but <%= htmlWebpackPlugin.options.title %> 
+        doesn't work properly without JavaScript enabled. Please enable it to continue.
+    </strong>
+    </noscript>
+    <div id="app"></div>
+    <!-- built files will be auto injected -->
+    <script src="./main.js"></script>
+
+  </body>
+</html>