:sparkles: first pass at initial db migration | uupdated docs

backend/README.md

@@ -16,6 +16,7 @@ You will need...
 1. Install dependencies with `npm install`
 2. Fill out your database connection details in `./config/dev.js`
 3. A test database container is provided and can be started with `docker-compose up -d`
+4. Populate some basic tables for your database using `npx knex migrate:latest`
 
 ## :electric_plug: Run
 

backend/db/knex.js

@@ -0,0 +1,3 @@
+const environment = process.env.NODE_ENV || 'development'
+const config = require('../knexfile')[environment]
+module.exports = require('knex')(config)

backend/db/migrations/20210524105357_create_initial_tables.js

@@ -0,0 +1,64 @@
+exports.up = function(knex) {
+    return knex.schema
+        .createTable('users', function(table) {
+            table.increments('user_id').primary()
+            table.string('user_name', 32).notNullable()
+            table.string('user_email', 90).notNullable()
+            table.timestamps(false, true) // Precision to the second
+        })
+        .createTable('accounts', function(table) {
+            table.increments('account_id').primary()
+            table.integer('user_id').notNullable()
+            table.timestamps(false, true) // Precision to the second
+        })
+        .createTable('logins', function(table) {
+            table.increments('login_id').primary()
+            table.integer('account_id').notNullable()
+            table.string('login_email', 90).notNullable()
+            table.string('login_password', 128).notNullable()
+            table.timestamps(false, true) // Precision to the second
+        })
+        .createTable('profiles', function(table) {
+            table.increments('profile_id').primary()
+            table.integer('account_id').notNullable()
+            table.string('profile_name', 128).notNullable()
+            table.json('profile_data').notNullable()
+            table.timestamps(false, true) // Precision to the second
+        })
+        .createTable('groupings', function(table) {
+            table.increments('grouping_id').primary()
+            table.string('grouping_name', 128).notNullable()
+            table.string('grouping_type', 128).notNullable() // Don't over normalize
+            table.timestamps(false, true) // Precision to the second
+        })
+        .createTable('memberships', function(table) {
+            table.increments('membership_id').primary()
+            table.integer('account_id').notNullable() // From
+            table.integer('group_id').notNullable() // To
+            table.string('membership_type', 128).notNullable() // Don't over normalize
+            table.string('membership_role', 128).notNullable() // Don't over normalize
+        })
+        .createTable('chats', function(table) {
+            table.increments('chat_id').primary()
+            table.integer('membership_id').notNullable()
+            table.timestamps(false, true) // Precision to the second
+        })
+        .createTable('messages', function(table) {
+            table.increments('message_id').primary()
+            table.integer('chat_id').notNullable()
+            table.integer('message_account_id').notNullable()
+            table.string('message', 255).notNullable()
+        })
+}
+
+exports.down = function(knex) {
+    return knex.schema
+        .dropTable('users')
+        .dropTable('accounts')
+        .dropTable('logins')
+        .dropTable('profiles')
+        .dropTable('memberships')
+        .dropTable('groupings')
+        .dropTable('chats')
+        .dropTable('messages')
+}

backend/knexfile.js

@@ -0,0 +1,24 @@
+require('dotenv').config()
+
+module.exports = {
+    development: {
+        client: 'mysql',
+        connection: {
+            host: 'localhost',
+            port: 3306,
+            user: 'root',
+            password: 'root',
+            database: 'test',
+        },
+        pool: {
+            min: 2,
+            max: 10
+        },
+        migrations: {
+            directory: './db/migrations'
+        },
+        seeds: {
+            directory: './db/seeds'
+        }
+    },
+};

backend/package-lock.json

@@ -13,6 +13,7 @@
         "@hapi/inert": "^6.0.3",
         "@hapi/vision": "^6.0.1",
         "@hapipal/schwifty": "^6.0.0",
+        "dotenv": "^10.0.0",
         "hapi-swagger": "^14.1.3",
         "joi": "^17.4.0",
         "knex": "^0.21.19",
@@ -1125,6 +1126,14 @@
         "node": ">=8"
       }
     },
+    "node_modules/dotenv": {
+      "version": "10.0.0",
+      "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-10.0.0.tgz",
+      "integrity": "sha512-rlBi9d8jpv9Sf1klPjNfFAuWDjKLwTIJJ/VxtoTwIR6hnZxcEOQCZg2oIL3MWBYw5GpUDKOEnND7LXTbIpQ03Q==",
+      "engines": {
+        "node": ">=10"
+      }
+    },
     "node_modules/duplexer3": {
       "version": "0.1.4",
       "resolved": "https://registry.npmjs.org/duplexer3/-/duplexer3-0.1.4.tgz",
@@ -4839,6 +4848,11 @@
         "is-obj": "^2.0.0"
       }
     },
+    "dotenv": {
+      "version": "10.0.0",
+      "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-10.0.0.tgz",
+      "integrity": "sha512-rlBi9d8jpv9Sf1klPjNfFAuWDjKLwTIJJ/VxtoTwIR6hnZxcEOQCZg2oIL3MWBYw5GpUDKOEnND7LXTbIpQ03Q=="
+    },
     "duplexer3": {
       "version": "0.1.4",
       "resolved": "https://registry.npmjs.org/duplexer3/-/duplexer3-0.1.4.tgz",

backend/package.json

@@ -5,6 +5,7 @@
   "main": "index.js",
   "scripts": {
     "start": "nodemon src/index.js",
+    "migrate": "knex migrate:latest",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "TOJ",
@@ -14,6 +15,7 @@
     "@hapi/inert": "^6.0.3",
     "@hapi/vision": "^6.0.1",
     "@hapipal/schwifty": "^6.0.0",
+    "dotenv": "^10.0.0",
     "hapi-swagger": "^14.1.3",
     "joi": "^17.4.0",
     "knex": "^0.21.19",