Ateliware - Dev Hiring Challenge

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.env.sample

@@ -0,0 +1,11 @@
+APP_PORT=3450
+GITHUB_BASE_URL="https://api.github.com/"
+GITHUB_AUTH_TOKEN=""
+
+# DATABASE_URL is only allowed on real productions services with ssl
+DATABASE_URL="postgresql://postgres:<your admin password>@localhost:5432/<your db name"
+DB_HOST=""
+DB_PORT=""
+DB_USERNAME=""
+DB_PASSWORD=""
+DB_DATABASE="ateliware_hiring_challenge"

.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,39 @@
+# compiled output
+/dist
+/node_modules
+
+# Application
+*.gql
+.env
+
+# Logs
+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,7 @@
+{
+  "singleQuote": true,
+  "trailingComma": "none",
+  "semi": false,
+  "arrowParens": "avoid",
+  "printWidth": 100
+}

Procfile

@@ -0,0 +1 @@
+web yarn start:prod

README.md

@@ -1,22 +1,93 @@
-# Desafio técnico para desenvolvedores
+# Ateliware - Dev Hiring Challenge - API
 
-Construa uma nova aplicação, utilizando o framework de sua preferência (Ruby on Rails, Elixir Phoenix, Python Django ou Flask, NodeJS Sails, Java Spring, ASP.NET ou outro), a qual deverá conectar na API do GitHub e disponibilizar as seguintes funcionalidades:
+> The challenge is to create a application to comunicate with GithubAPI and implement the features bellow.
+>
+> - Button to search and save most featured repositories of five languages.
+> - List found repositories.
+> - Create repository details view.
 
-- Botão para buscar e armazenar os repositórios destaques de 5 linguagens à sua escolha;
-- Listar os repositórios encontrados;
-- Visualizar os detalhes de cada repositório.
+## Live Preview
 
-Alguns requisitos:
+[https://ateliware-prod-frontend.herokuapp.com](https://ateliware-prod-frontend.herokuapp.com)
 
-- Deve ser uma aplicação totalmente nova;
-- A solução deve estar em um repositório público do GitHub;
-- A aplicação deve armazenar as informações encontradas;
-- Utilizar PostgreSQL, MySQL ou SQL Server;
-- O deploy deve ser realizado, preferencialmente, no Heroku, AWS ou no Azure;
-- A aplicação precisa ter testes automatizados;
-- Preferenciamente dockerizar a aplicação;
-- Por favor atualizar o readme da aplicação com passo a passo com instrução para subir o ambiente.
+## Technologies
 
-Quando terminar, faça um Pull Request neste repo e avise-nos por email.
+- [GraphQL](https://graphql.org)
+- [Jest](https://jestjs.io/pt-BR/)
+- [NestJS](https://nestjs.com)
+- [TypeORM](https://typeorm.io)
 
-**IMPORTANTE:** se você não conseguir finalizar o teste, por favor nos diga o motivo e descreva quais foram as suas dificuldades. Você pode também sugerir uma outra abordagem para avaliarmos seus skills técnicos, vender seu peixe, mostrar-nos do que é capaz.
+## Application Architecture
+
+### API
+
+- [Dev Hiring Challenge API](https://github.com/Leonardo-Figueiredo/dev-hiring-challenge) (this repository)
+
+### Client
+
+- [Dev Hiring Challenge Client](https://github.com/Leonardo-Figueiredo/dev-hiring-challenge-frontend)
+
+---
+
+## Dependencies
+
+- [Node ^16.15.1](https://nodejs.org/dist/v16.15.1/docs/api/)
+- [Postgres ^14.4](https://www.postgresql.org)
+- [Yarn ^1.22.19](https://yarnpkg.com)
+
+_The dependencies above are unnecessary if you use docker, the ones below are required._
+
+- [Docker Engine ^20.10.12](https://docs.docker.com/engine/install/)
+- [Docker Compose ^1.29.2](https://docs.docker.com/compose/install/)
+
+---
+
+## Base Setup
+
+- Create a Postgres database.
+- Run `$ cp .env.sample .env` (or just make a copy), populate .env file with valid keys.
+
+## Local Setup (without Docker, with Docker [go to](#docker-setup-🐳))
+
+- Follow the steps above on [Base Setup](#base-setup)
+- Run `$ yarn` to install all dependencies.
+- Run `$ yarn ts-typeorm -d ./src/modules/shared/data-source.ts migration:run` to create database tables.
+- Run test with: `$ yarn test`.
+- To start Ateliware Challenge API in development mode with `$ yarn start:dev`.
+- Build production Ateliware Challenge API with `$ yarn build`.
+- To start Ateliware Challenge API in production mode with `$ yarn start:prod`.
+
+## Docker Setup 🐳
+
+- Follow the steps above on [Base Setup](#base-setup).
+- Run `$ docker-compose build development` to create development or production image.
+- Run the migrations with `$ docker-compose exec development $ yarn ts-typeorm -d ./src/modules/shared/data-source.ts migration:run`.
+- To execute **production** container use `$ docker-compose up production`.
+- If you want to execute on background, use **-d** flag, example: `$ docker-compose up -d production`.
+- To execute **development** container use `$ docker-compose up development`.
+- Stop containers and dependencies, execute `$ docker-compose stop`.
+  - To stop a especific container execute `$ docker-compose stop development`.
+- Now run `$ docker-compose up -d development` and Ateliware Challenge API should be working fine. 🚀
+- To up a container with new build, you should run `$ docker-compose up --build -d production`.
+
+Open [http://localhost:3450](http://localhost:3450) with your browser to see the result.
+
+_If you change the default port on .env, you should enter on <http://localhost:APP_PORT>_
+
+### Migration Commands
+
+```bash
+# create
+$ yarn ts-typeorm migration:create ./src/modules/shared/migrations/MIGRATION_NAME
+
+# run
+$ yarn ts-typeorm -d ./src/modules/shared/data-source.ts migration:run
+
+# revert
+$ yarn ts-typeorm -d ./src/modules/shared/data-source.ts migration:revert
+
+```
+
+[Challenge Original Repository](https://github.com/ateliware/dev-hiring-challenge)
+
+If you have any problems, send me a e-mail [[email protected]](mailto:[email protected])

docker-compose.yml

@@ -0,0 +1,27 @@
+version: "3.8"
+
+services:
+  development:
+    container_name: ateliware-challenge-api-development
+    image: ateliware-challenge-api-development:1.0.0
+    restart: unless-stopped
+    build:
+      context: .
+      target: development
+      dockerfile: ./dockerfile
+    volumes:
+      - .:/usr/app
+    network_mode: host
+
+  production:
+    container_name: ateliware-challenge-api-production
+    image: ateliware-challenge-api-production:1.0.0
+    restart: unless-stopped
+    build:
+      context: .
+      target: production
+      dockerfile: ./dockerfile
+    volumes:
+      - .:/usr/app
+    network_mode: host
+

dockerfile

@@ -0,0 +1,37 @@
+############### Development ###############
+
+FROM node:16.15.1-alpine AS development
+
+ARG NODE_ENV=development
+ENV NODE_ENV=${NODE_ENV}
+
+WORKDIR /usr/app
+
+COPY package.json ./
+
+RUN yarn global add rimraf
+RUN yarn install
+
+COPY . .
+
+CMD ["yarn", "start:dev"]
+
+############### Production ###############
+
+FROM node:16.15.1-alpine AS production
+
+ARG NODE_ENV=production
+ENV NODE_ENV=${NODE_ENV}
+
+WORKDIR /usr/app
+
+COPY package.json ./
+
+RUN yarn global add rimraf
+RUN yarn install
+
+COPY . .
+
+RUN yarn build
+
+CMD ["yarn", "start:prod"]

nest-cli.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src"
+}

package.json

@@ -0,0 +1,83 @@
+{
+  "name": "dev-hiring-challenge",
+  "version": "0.0.1",
+  "author": "Leonardo Figueiredo <[email protected]>",
+  "private": true,
+  "license": "UNLICENSED",
+  "engines": {
+    "node": "16.15.1",
+    "yarn": "1.x"
+  },
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "ts-typeorm": "NODE_ENV=typeorm typeorm-ts-node-esm",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "dependencies": {
+    "@nestjs/apollo": "10.0.16",
+    "@nestjs/common": "8.4.7",
+    "@nestjs/core": "8.0.0",
+    "@nestjs/graphql": "10.0.16",
+    "@nestjs/platform-express": "8.0.0",
+    "apollo-server-express": "3.9.0",
+    "@nestjs/cli": "8.2.8",
+    "dotenv": "16.0.1",
+    "graphql": "16.5.0",
+    "pg": "8.7.3",
+    "reflect-metadata": "0.1.13",
+    "rimraf": "3.0.2",
+    "rxjs": "7.2.0",
+    "typeorm": "0.3.6"
+  },
+  "devDependencies": {
+    "@faker-js/faker": "7.3.0",
+    "@nestjs/schematics": "8.0.0",
+    "@nestjs/testing": "8.0.0",
+    "@types/express": "4.17.13",
+    "@types/jest": "27.5.0",
+    "@types/node": "16.0.0",
+    "@types/supertest": "2.0.11",
+    "@typescript-eslint/eslint-plugin": "5.0.0",
+    "@typescript-eslint/parser": "5.0.0",
+    "eslint": "8.0.1",
+    "eslint-config-prettier": "8.3.0",
+    "eslint-plugin-prettier": "4.0.0",
+    "jest": "28.0.3",
+    "prettier": "2.3.2",
+    "source-map-support": "0.5.20",
+    "supertest": "6.1.3",
+    "ts-jest": "28.0.1",
+    "ts-loader": "9.2.3",
+    "ts-node": "10.8.1",
+    "tsconfig-paths": "4.0.0",
+    "typescript": "4.3.5"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}

src/app.module.ts

@@ -0,0 +1,19 @@
+import { ApolloDriver, ApolloDriverConfig } from '@nestjs/apollo'
+import { Module } from '@nestjs/common'
+import { GraphQLModule } from '@nestjs/graphql'
+import { RepoModule } from './modules/repo/repo.module'
+import { SharedModule } from './modules/shared/shared.module'
+
+@Module({
+  imports: [
+    SharedModule,
+    RepoModule,
+    GraphQLModule.forRoot<ApolloDriverConfig>({
+      driver: ApolloDriver,
+      playground: process.env.NODE_ENV !== 'production',
+      autoSchemaFile: true,
+      cache: 'bounded'
+    })
+  ]
+})
+export class AppModule {}

src/main.ts

@@ -0,0 +1,14 @@
+import 'dotenv/config'
+import { NestFactory } from '@nestjs/core'
+import { AppModule } from './app.module'
+
+async function bootstrap() {
+  const PORT = process.env.PORT || process.env.APP_PORT || 3000
+
+  const app = await NestFactory.create(AppModule)
+  await app.listen(PORT)
+
+  console.log(`\n 🎊  Server is up on port ${PORT} 🚀 \n`)
+}
+
+bootstrap()