Feat: Update docker-compose images, app.json for Heroku and add sendgrid config

Author: kevenleone

Diff for: Procfile

@@ -0,0 +1,2 @@
+server: npm run all:server
+worker: npm run all:worker

Diff for: README.md

@@ -50,10 +50,6 @@ Graphscript implement the following features
 - `npm start` - start the playground pointing for dist index at `http://localhost:3333/playground`
 - `npm run build` - Builds the project: Typescript to Javascript
 
-## :art: Inspired on
-
-Project inspired on Krakren -> https://github.com/wendelfreitas/kraken
-
 ## :handshake: **Contributing**
 If you liked the project and want to cooperate feel free to fork this repository and send Pull Requests.
 
@@ -63,5 +59,17 @@ All kinds of contributions are very welcome and appreciated
 -   🐛 Find and report issues
 -   📥 Submit PRs to help solve issues or add features
 
+## :package: Deployment
+
+This project comes with a `app.json` file for heroku, that can be used to create an app on heroku from a GitHub repository.
+
+After setting up the project, you can init a repository and push it on GitHub. If your repository is public, you can use the following button:
+
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/kevenleone/graphscript.git)
+
+If you are in a private repository, access the following link replacing `$YOUR_REPOSITORY_LINK$` with your repository link.
+
+- `https://heroku.com/deploy?template=$YOUR_REPOSITORY_LINK$`
+
 ## :book: License
 MIT license, Copyright (c) 2020 Keven Leone.

Diff for: app.json

@@ -1,30 +1,26 @@
 {
   "name": "graphscript",
   "description": "Graphscript boilerplate",
+  "keywords": [
+    "GraphQL",
+    "NodeJS",
+    "Typescript",
+    "Javascript",
+    "Boilerplate"
+  ],
   "env": {
     "AUTH_MIDDLEWARE_ENABLED": {
+      "value": true
     },
     "JWT_SECRET": {
       "generator": "secret"
     },
-    "MAIL_HOST": {
-      "value": "1"
-    },
-    "MAIL_PASS": {
-      "value": "1"
-    },
-    "MAIL_USER": {
-      "value": "1"
-    },
-    "MAIL_PORT": {
-      "value": "gitcommits.settings.production"
-    },
     "MAIL_FROM": {
-      "generator": "secret"
+      "value": "Fred Foo 👻 <[email protected]>"
     }
-  },
+  },  
   "formation": {
-    "web": {
+    "server": {
       "quantity": 1,
       "size": "free"
     },
@@ -39,7 +35,7 @@
       "options": {
         "version": "9.5"
       },
-      "as": "DATABASE"
+      "as": "POSTGRES"
     },
     {
       "plan": "heroku-redis:hobby-dev",
@@ -50,12 +46,12 @@
     },
     {
       "plan": "sendgrid:starter"
-    },
-    {
-      "plan": "papertrail:choklad"
     }
   ],
   "buildpacks": [
+    {
+      "url": "heroku/nodejs"
+    },
     {
       "url": "heroku/nodejs"
     }

Diff for: docker-compose.yml

@@ -1,22 +1,33 @@
 version: '3'
 services: 
-  mongodb:
-    image: mongo:latest
-    container_name: mongodb
-    ports: 
-      - '27017:27017'
+  postgres:
+    image: postgres:latest
+    container_name: postgres
+    expose:
+      - 5432
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: root
+      POSTGRES_DB: graphscript
     volumes:
       - './data:/data/db'
+  redis:
+    image: redis:latest
+    container_name: redis
+    ports:
+      - '6379:6379'
   api:
     build: .
-    container_name: graphscript-service
-    command: npm start
+    container_name: graphscript
+    command: npm run dev
     ports: 
       - '3333:3333'
     volumes: 
       - .:/app
     depends_on: 
-      - mongodb
+      - postgres
+      - redis
     links:
-      - mongodb
+      - postgres
+      - redis
 

Diff for: package.json

@@ -58,6 +58,7 @@
     "jsonwebtoken": "^8.5.1",
     "link-module-alias": "^1.2.0",
     "nodemailer": "^6.3.1",
+    "nodemailer-sendgrid-transport": "^0.2.0",
     "pg": "^7.17.1",
     "reflect-metadata": "^0.1.13",
     "ts-node": "^8.5.0",

Diff for: src/config/defaults.ts

@@ -21,14 +21,18 @@ const {
   MAIL_USER,
   MAIL_PASS,
   MAIL_FROM,
-  REDIS_HOST,
+  REDIS_URL,
   REDIS_PORT,
+  SENDGRID_USERNAME,
+  SENDGRID_PASSWORD,
 } = process.env;
 
 export default {
   CONSTANTS,
-  REDIS_HOST,
+  REDIS_URL,
   REDIS_PORT,
+  SENDGRID_USERNAME,
+  SENDGRID_PASSWORD,
   AUTH_MIDDLEWARE_ENABLED: normalizeBool(AUTH_MIDDLEWARE_ENABLED, false),
   RUN_PLAYGROUND: normalizeBool(RUN_PLAYGROUND, NODE_ENV !== 'production'),
   APP_NAME: APP_NAME || 'Graphscript',

Diff for: src/utils/Queue.ts

@@ -1,12 +1,11 @@
 import Queue from 'bull';
-import { defaults, logger } from './globalMethods';
-const { REDIS_HOST } = defaults;
-
-import * as Jobs from '../jobs';
+import * as Jobs from '~/jobs';
+import { defaults, logger } from '~/utils/globalMethods';
+const { REDIS_URL } = defaults;
 
 const queues = Object.values(Jobs).map(job => {
   const { name, data, handle, config, selfRegister = false, active = true }: any = job;
-  const bull = new Queue(name, { redis: { host: REDIS_HOST } });
+  const bull = new Queue(name, { redis: { host: REDIS_URL } });
   if (selfRegister && active) bull.add(data, config);
   return {
     bull,
@@ -33,10 +32,6 @@ export default {
       if (active) {
         queue.bull.process(queue.handle);
 
-        queue.bull.on('active', () => {
-          logger.info(`[${name}] | [ACTIVE]`);
-        });
-
         queue.bull.on('completed', () => {
           logger.info(`[${name}] | [COMPLETED]`);
         });

Diff for: src/utils/globalMethods.ts

@@ -1,4 +1,6 @@
+/* eslint-disable @typescript-eslint/camelcase */
 import { gql } from 'apollo-server-express';
+import sendgridTransport from 'nodemailer-sendgrid-transport';
 
 import { Pagination, MailConfig } from '~/interfaces';
 import Constants from '~/utils/contants';
@@ -38,16 +40,23 @@ export function HttpError(message: string): Error {
  */
 
 export function MailerCredentials(): MailConfig {
-  const { MAIL_HOST, MAIL_PORT, MAIL_USER, MAIL_PASS } = defaults;
-  const config: MailConfig = {
+  const { MAIL_HOST, MAIL_PORT, MAIL_USER, MAIL_PASS, SENDGRID_USERNAME, SENDGRID_PASSWORD } = defaults;
+  if (SENDGRID_USERNAME && SENDGRID_PASSWORD) {
+    return sendgridTransport({
+      auth: {
+        api_user: SENDGRID_USERNAME,
+        api_key: SENDGRID_PASSWORD,
+      },
+    });
+  }
+  return {
     host: MAIL_HOST,
     port: MAIL_PORT,
     auth: {
       user: MAIL_USER,
       pass: MAIL_PASS,
     },
   };
-  return config;
 }
 
 /**

Diff for: types/nodemailer-sendgrid-transport/index.d.ts

@@ -0,0 +1 @@
+declare module 'nodemailer-sendgrid-transport';