Add deploy to heroku

README.md

@@ -77,6 +77,10 @@ To execute Kutt you simply have to run `docker-compose up -d` command and then t
 
 The `docker-compose.yml` uses the official kutt docker image available on [Docker Hub](https://hub.docker.com/r/kutt/kutt).
 
+### Heroku
+
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
+
 ### Configuration
 
 For the minimal configuration the following settings have to be changed in the `.env`-file:

app.json

@@ -0,0 +1,48 @@
+{
+    "name": "Kutt",
+    "description": "Free Modern URL Shortener.",
+    "website": "https://kutt.it",
+    "repository": "https://github.com/thedevs-network/kutt",
+    "logo": "https://kutt.it/images/logo.svg",
+    "success_url": "/",
+    "env": {
+      "NPM_CONFIG_PRODUCTION": {
+        "value": "false"
+      },
+      "PGSSLMODE": {
+        "value": "no-verify"
+      },
+      "SITE_NAME": {
+        "value": "Kutt"
+      },
+      "DEFAULT_DOMAIN": {
+        "value": "CHANGE.herokuapp.com"
+      },
+      "JWT_SECRET": {
+        "generator": "secret"
+      },
+      "MAIL_HOST": {
+        "required": false,
+        "value": ""
+      },
+      "MAIL_PORT": {
+        "required": false,
+        "value": ""
+      },
+      "MAIL_USER": {
+        "required": false,
+        "value": ""
+      },
+      "MAIL_PASSWORD": {
+        "required": false,
+        "value": ""
+      }
+    },
+    "formation": {
+      "web": {
+        "quantity": 1,
+        "size": "FREE"
+      }
+    },
+    "addons": [ "heroku-redis", "heroku-postgresql"]
+  }

knexfile.ts

@@ -3,7 +3,7 @@ import env from "./server/env";
 module.exports = {
   production: {
     client: "postgresql",
-    connection: {
+    connection: env.DATABASE_URL || {
       host: env.DB_HOST,
       database: env.DB_NAME,
       user: env.DB_USER,

server/env.ts

@@ -1,10 +1,12 @@
-import { cleanEnv, num, str, bool } from "envalid";
+import { cleanEnv, num, str, bool, url, EnvMissingError } from "envalid";
+import reporter from "envalid/src/reporter";
 
 const env = cleanEnv(process.env, {
   PORT: num({ default: 3000 }),
   SITE_NAME: str({ example: "Kutt" }),
   DEFAULT_DOMAIN: str({ example: "kutt.it" }),
   LINK_LENGTH: num({ default: 6 }),
+  DATABASE_URL: url(),
   DB_HOST: str({ default: "localhost" }),
   DB_PORT: num({ default: 5432 }),
   DB_NAME: str({ default: "postgres" }),
@@ -16,6 +18,7 @@ const env = cleanEnv(process.env, {
   NEO4J_DB_URI: str({ default: "" }),
   NEO4J_DB_USERNAME: str({ default: "" }),
   NEO4J_DB_PASSWORD: str({ default: "" }),
+  REDIS_URL: url(),
   REDIS_HOST: str({ default: "127.0.0.1" }),
   REDIS_PORT: num({ default: 6379 }),
   REDIS_PASSWORD: str({ default: "" }),
@@ -42,6 +45,20 @@ const env = cleanEnv(process.env, {
   CONTACT_EMAIL: str({ default: "" }),
   SENTRY_PRIVATE_DSN: str({ default: "" }),
   SENTRY_PUBLIC_DSN: str({ default: "" })
+}, {
+  reporter: ({errors, env}: {errors: { [key: string]: Error }, env: any}) => {
+    if (env.DATABASE_URL !== undefined) {
+      delete errors['DB_USER'];
+      delete errors['DB_PASSWORD'];
+    }
+    if (env.DB_USER !== undefined && env.DB_PASSWORD !== undefined) {
+      delete errors['DATABASE_URL'];
+    }
+    if (errors['REDIS_URL'] instanceof EnvMissingError) {
+      delete errors['REDIS_URL'];
+    }
+    reporter({errors, env});
+  }
 });
 
 export default env;

server/knex.ts

@@ -2,7 +2,7 @@ import knex from "knex";
 
 import env from "./env";
 
-const db = knex({
+const db = knex(env.DATABASE_URL || {
   client: "postgres",
   connection: {
     host: env.DB_HOST,

server/migration/01_host.ts

@@ -12,7 +12,7 @@ const neo4j = NEO4J.driver(
   NEO4J.auth.basic(env.NEO4J_DB_USERNAME, env.NEO4J_DB_PASSWORD)
 );
 // 2. Connect to Postgres database
-const postgres = knex({
+const postgres = knex(env.DATABASE_URL || {
   client: "postgres",
   connection: {
     host: env.DB_HOST,

server/migration/02_users.ts

@@ -12,7 +12,7 @@ const neo4j = NEO4J.driver(
   NEO4J.auth.basic(env.NEO4J_DB_USERNAME, env.NEO4J_DB_PASSWORD)
 );
 // 2. Connect to Postgres database
-const postgres = knex({
+const postgres = knex(env.DATABASE_URL || {
   client: "postgres",
   connection: {
     host: env.DB_HOST,

server/migration/03_domains.ts

@@ -12,7 +12,7 @@ const neo4j = NEO4J.driver(
   NEO4J.auth.basic(env.NEO4J_DB_USERNAME, env.NEO4J_DB_PASSWORD)
 );
 // 2. Connect to Postgres database
-const postgres = knex({
+const postgres = knex(env.DATABASE_URL || {
   client: "postgres",
   connection: {
     host: env.DB_HOST,

server/migration/04_links.ts

@@ -17,7 +17,7 @@ const neo4j = NEO4J.driver(
 );
 
 // 2. Connect to Postgres database
-const postgres = knex({
+const postgres = knex(env.DATABASE_URL || {
   client: "postgres",
   connection: {
     host: env.DB_HOST,

server/queues/queues.ts

@@ -3,7 +3,7 @@ import path from "path";
 
 import env from "../env";
 
-const redis = {
+const redis = env.REDIS_URL || {
   port: env.REDIS_PORT,
   host: env.REDIS_HOST,
   ...(env.REDIS_PASSWORD && { password: env.REDIS_PASSWORD })

server/redis.ts

@@ -4,6 +4,7 @@ import redis from "redis";
 import env from "./env";
 
 const client = redis.createClient({
+  url: env.REDIS_URL,
   host: env.REDIS_HOST,
   port: env.REDIS_PORT,
   ...(env.REDIS_PASSWORD && { password: env.REDIS_PASSWORD })