Desafio concluído (Lucas Pereira Miranda)

.editorconfig

@@ -0,0 +1,10 @@
+# EditorConfig is awesome: https://EditorConfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = false
+insert_final_newline = false

.env.example

@@ -0,0 +1,18 @@
+# API configuration
+API_BASE_URL=http://localhost
+API_PORT=3000
+API_PREFIX=/api/v1
+
+# Database ORM configuration
+DB_CONNECTION=mysql
+DB_HOST=0.0.0.0
+DB_PORT=3306
+DB_USERNAME=root
+DB_PASSWORD=lucasdevpassword
+DB_NAME=challenge_db
+
+# TypeORM internals
+TYPEORM_SYNCHRONIZE=
+
+# Multer Options
+MULTER_DESTINATION=

.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'prettier/@typescript-eslint',
+    '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,42 @@
+# compiled output
+/dist
+/node_modules
+
+# Environment
+.env
+
+# Logs
+logs
+*.log
+npm-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
+
+
+# Uploads folder
+uploads/*
+!uploads/.gitkeep

.prettierrc

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

README.md

@@ -1,13 +1,28 @@
 # Desafio de Backend
 
-<img src="./img/logo-clubpetro.png" style="margin-left: 100px"
+<img src="./.github/img/logo-clubpetro.png" style="margin-left: 100px"
      alt="Clubpetro" width="300">
 
 - [Descrição](#descrição)
   - [O Desafio](#o-desafio)
   - [Requisitos Obrigatórios](#requisitos-obrigatórios)
   - [Bônus](#bônus)
 - [Submissão e Prazo de Entrega](#submissão-e-prazo-de-entrega)
+- [Instruções de execução](#instruções-de-execução)
+  - [Requisitos para execução](#requisitos-para-execução)
+  - [Instalação das dependências](#instalação-das-dependências)
+  - [Variáveis de ambiente](#variáveis-de-ambiente)
+  - [Container Docker](#container-docker)
+  - [Migrações](#migrações)
+  - [Execução da aplicação](#execução-da-aplicação)
+- [Endpoints disponíveis](endpoints-disponíveis)
+  - [Recursos para Files](#recursos-para-files)
+  - [Recursos para Countries](#recursos-para-countries)
+  - [Recursos para Locals](#recursos-para-locals)
+  - [Recursos para Metas](#recursos-para-metas)
+- [Jornada de criações POST do cliente da API](#jornada-de-criações-post-do-cliente-da-api)
+
+
 
 ## Descrição
 
@@ -17,7 +32,7 @@ Este desafio tem como objetivo avaliar as habilidades técnicas do candidato a v
 
 O desafio consiste em desenvolver uma API rest que permita o CRUD de lugares para se conhecer ao redor do mundo para alimentar o frontend que pode ser visto na imagem a seguir:
 
-<img src="./img/challenge.png" alt="Desafio" >
+<img src="./.github/img/challenge.png" alt="Desafio" >
 
 Os dados a ser considerados são:
 
@@ -55,3 +70,154 @@ Os dados a ser considerados são:
 - Em caso do deploy realizado, a url deverá ser adicionada no README;
 - O prazo de entrega para este desafio é de 2 (duas) semanas, contando a partir do dia em que o canditado recebeu o email com o link do repositório;
 - Ao finalizar o desafio, o candidato deverá enviar um email para [email protected] contendo o link do seu PR.
+
+
+# Instruções de execução
+
+## Requisitos para execução
+
+Para executar a aplicação no ambiente de desenvolvimento, precisamos ter no ambiente:
+
+- [Docker](https://www.docker.com/)
+- [Docker Compose](https://docs.docker.com/compose/install/)
+- [yarn](https://classic.yarnpkg.com/en/docs/install/#debian-stable)
+- [nest-cli](https://docs.nestjs.com/cli/overview)
+
+## Instalação das dependências
+
+Dentro do diretório raiz do projeto, podemos executar
+
+```bash
+$ yarn
+```
+para instalar as dependências.
+
+## Variáveis de ambiente
+
+Duplique o arquivo .env.example presente na raiz do projeto e renomeie uma das cópias para apenas .env
+
+O arquivo .env contém as variáveis de ambiente com informações secretas que serão utilizadas na API.
+
+## Container Docker
+
+Após instalar as dependências, podemor subir o container contendo o serviço MySQL.
+
+O serviço relativo ao banco de dados MySQL está configurado para escutar a porta 3306. Caso essa porta já esteja sendo usada em seu ambiente, deixe ela disponível para o container, por favor.
+
+Após esses detalhes, podemos executar:
+
+```bash
+$ docker-compose up
+```
+
+Esse processo pode demorar um pouco caso as imagens Docker não estejam disponíveis em seu ambiente local.
+
+## Migrações
+
+Após o container contendo o MySQL estiver disponível para conexões, execute o seguinte comando para executar as migrações no banco de dados:
+
+```bash
+$ yarn typeorm migration:run
+```
+
+## Execução da aplicação
+
+Agora podemos iniciar a aplicação (modo de desenvolvimento) executando:
+
+```bash
+# development mode
+$ yarn start
+```
+
+# Endpoints disponíveis
+
+A URL base no ambiente de desenvolvimento é http://localhost:3000/api/v1/
+
+***Obs***: As listagens utilizam [eager loading](https://orkhan.gitbook.io/typeorm/docs/eager-and-lazy-relations) para carregar os dados das relações.
+
+## Recursos para Files
+
+***Obs***: Files é o arquivo relativo a bandeira de um país.
+
+- `POST /files`: Cria um novo arquivo enviado como multipart/form a chave `file`. O arquivo deve ser uma imagem com extensão `.png`, `.jpg` ou `.jpeg`
+
+- `GET /files/:id`: O arquivo com `id` presente no parâmetro da rota deve ter seus dados retornados.
+
+## Recursos para Countries
+
+- `POST /countries`: 
+O endpoint deve receber `name` e `fileId` no corpo da requisição e registrar um novo país.
+
+- `GET /countries`: 
+Rota que lista todos os países presentes no repositório.
+
+- `GET /countries/:id`: 
+O país com `id` presente no parâmetro da rota deve ter seus dados retornados.
+
+- `DELETE /countries/:id`: 
+O País com `id` presente no parâmetro da rota deve ser excluído.
+
+- `GET /countries/:id/locals`:
+Retorna os locais relacionados ao `id` do País presente no parâmetro da rota.
+
+
+## Recursos para Locals
+
+- `POST /locals`: 
+O endpoint deve receber `name` e `countryId` no corpo da requisição e registrar um novo local.
+
+- `GET /locals`: 
+Rota que lista todos os locais presentes no repositório.
+
+- `GET /locals/:id`: 
+O local com `id` presente no parâmetro da rota deve ter seus dados retornados.
+
+- `DELETE /locals/:id`: 
+O local com `id` presente no parâmetro da rota deve ser excluído.
+
+- `PUT /locals/:id`: 
+O endpoint pode receber `name` e `countryId` no corpo da requisição e alterar o local relativo ao `id` presente no parâmetro da rota.
+
+
+## Recursos para Metas
+
+- `POST /metas`: 
+O endpoint deve receber `date` (ISO-8601) e `localId` no corpo da requisição para registrar uma nova meta.
+
+- `GET /metas`: 
+Rota que lista todas as metas presentes no repositório.
+
+- `GET /metas/:id`: 
+A meta com `id` presente no parâmetro da rota deve ter seus dados retornados.
+
+- `DELETE /metas/:id`: 
+A meta com `id` presente no parâmetro da rota deve ser excluída.
+
+- `PUT /metas/:id`:
+O endpoint pode receber `date` no corpo da requisição e alterar a meta relativa ao `id` presente no parâmetro da rota.
+
+
+# Jornada de criações POST do cliente da API
+
+Nesta seção temos um exemplo com requisições POST nos principais endpoints da API usando o [Insomnia](https://insomnia.rest/).
+O objetivo é criar uma meta com todos os seus dados relacionados (bandeira, local e país)
+
+1) Receber um arquivo (bandeira). Veja mais em [Recursos para Files](#recursos-para-files))
+
+<img src="./.github/example/criar-arquivo.png" style="margin-left: 0px"
+     alt="Requisição POST para receber arquivo" width="700">
+
+2) Criar um novo país. Veja mais em [Recursos para Countries](#recursos-para-countries)
+
+<img src="./.github/example/criar-pais.png" style="margin-left: 0px"
+     alt="Requisição POST para criar país" width="700">
+
+3) Criar um local "dentro" do país. Veja mais em [Recursos para Locals](#recursos-para-locals)
+
+<img src="./.github/example/criar-local.png" style="margin-left: 0px"
+     alt="Requisição POST para criar um local" width="700">
+
+4) Criar uma meta associada a um local. Veja mais em [Recursos para Metas](#recursos-para-metas)
+
+<img src="./.github/example/criar-meta.png" style="margin-left: 0px"
+     alt="Requisição POST para criar uma meta associada a um local" width="700">

docker-compose.yml

@@ -0,0 +1,23 @@
+version: '3.7'
+
+services:
+  mysql_db:
+    container_name: mysql_db
+    image: mysql:5.7
+    environment:
+      MYSQL_DATABASE: ${DB_NAME}
+      MYSQL_ROOT_PASSWORD: ${DB_PASSWORD}
+    ports:
+      - ${DB_PORT}:${DB_PORT}
+    restart: always
+    volumes:
+      - dbdata:/var/lib/mysql
+
+  adminer:
+      image: adminer
+      restart: always
+      ports:
+        - 8080:8080
+
+volumes:
+  dbdata:

nest-cli.json

@@ -0,0 +1,4 @@
+{
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src"
+}