:gear: altering response_key schema | :pencil: outlined backend object use

backend/README.md

@@ -43,6 +43,7 @@ Since we can't unseed the database, it's best to destroy the `dev` database and
 ## :electric_plug: Run
 
 1. Run `npm run start` to start up the server
+2. Check `http://localhost:3001/documentation` to see the interactive `API` documentation
 
 ## :robot: Deployment
 

backend/db/migrations/20210527174416_create_response_keys_table.js

@@ -1,7 +1,8 @@
 exports.up = function (knex) {
     return knex.schema.createTable('response_keys', function (table) {
         table.increments('response_key_id').primary()
-        table.string('response_key_name').notNullable()
+        table.string('response_key_category').notNullable()
+        table.string('response_key_prompt')
         table.string('response_key_description')
     })
 }

backend/db/mock.js

@@ -1,10 +1,40 @@
 module.exports = {
     users: [
-        { user_id: 1, user_name: 'usample', user_email: 'user_sample@doggo.com', is_admin: true, is_poster: false },
-        { user_id: 2, user_name: 'fifi', user_email: 'fifi@ismycat.com', is_admin: false, is_poster: false },
-        { user_id: 3, user_name: 'mochi', user_email: 'mochi@issomeothercat.com', is_admin: false, is_poster: false },
-        { user_id: 4, user_name: 'archie', user_email: 'ar_cat@hires.com', is_admin: false, is_poster: true },
-        { user_id: 5, user_name: 'lulu', user_email: 'totallylegit@pets.com', is_admin: false, is_poster: false },
+        {
+            user_id: 1,
+            user_name: 'usample',
+            user_email: 'user_sample@doggo.com',
+            is_admin: true,
+            is_poster: false,
+        },
+        {
+            user_id: 2,
+            user_name: 'fifi',
+            user_email: 'fifi@ismycat.com',
+            is_admin: false,
+            is_poster: false,
+        },
+        {
+            user_id: 3,
+            user_name: 'mochi',
+            user_email: 'mochi@issomeothercat.com',
+            is_admin: false,
+            is_poster: false,
+        },
+        {
+            user_id: 4,
+            user_name: 'archie',
+            user_email: 'ar_cat@hires.com',
+            is_admin: false,
+            is_poster: true,
+        },
+        {
+            user_id: 5,
+            user_name: 'lulu',
+            user_email: 'totallylegit@pets.com',
+            is_admin: false,
+            is_poster: false,
+        },
     ],
     profiles: [
         { profile_id: 1, user_id: 2 },
@@ -15,47 +45,163 @@ module.exports = {
         { profile_id: 6, user_id: 4 },
     ],
     response_keys: [
-        { response_key_id: 1, response_key_name: 'grit', response_key_description: null },
-        { response_key_id: 2, response_key_name: 'openness', response_key_description: null },
-        { response_key_id: 3, response_key_name: 'description', response_key_description: null },
+        {
+            response_key_id: 1,
+            response_key_category: 'grit',
+            response_key_prompt: 'question for grit',
+            response_key_description: null,
+        },
+        {
+            response_key_id: 2,
+            response_key_category: 'openness',
+            response_key_prompt: 'question for openness',
+            response_key_description: null,
+        },
+        {
+            response_key_id: 3,
+            response_key_category: 'empathy',
+            response_key_prompt: 'question for empathy',
+            response_key_description: null,
+        },
     ],
     responses: [
         { response_id: 1, profile_id: 2, response_key_id: 2, val: '80' },
         { response_id: 2, profile_id: 2, response_key_id: 1, val: '70' },
         { response_id: 3, profile_id: 2, response_key_id: 1, val: '50' },
-        { response_id: 4, profile_id: 2, response_key_id: 3, val: 'I am actually a very experienced cat.' },
-        { response_id: 5, profile_id: 3, response_key_id: 3, val: 'I am not a person but I need a job' },
-        { response_id: 6, profile_id: 4, response_key_id: 3, val: 'Just a job that needs grit' },
+        {
+            response_id: 4,
+            profile_id: 2,
+            response_key_id: 3,
+            val: 'I am actually a very experienced cat.',
+        },
+        {
+            response_id: 5,
+            profile_id: 3,
+            response_key_id: 3,
+            val: 'I am not a person but I need a job',
+        },
+        {
+            response_id: 6,
+            profile_id: 4,
+            response_key_id: 3,
+            val: 'Just a job that needs grit',
+        },
         { response_id: 7, profile_id: 4, response_key_id: 2, val: '30' },
         { response_id: 8, profile_id: 4, response_key_id: 1, val: '100' },
-        { response_id: 9, profile_id: 5, response_key_id: 3, val: 'This job posting is awful' },
+        {
+            response_id: 9,
+            profile_id: 5,
+            response_key_id: 3,
+            val: 'This job posting is awful',
+        },
     ],
     memberships: [
-        { membership_id: 1, user_id: 1, grouping_id: 1, membership_type: '_admin', can_edit: true, is_active: true },
-        { membership_id: 2, user_id: 1, grouping_id: 2, membership_type: 'recruiter', can_edit: true, is_active: true },
-        { membership_id: 3, user_id: 1, grouping_id: 3, membership_type: 'participant', can_edit: false, is_active: true },
-        { membership_id: 4, user_id: 2, grouping_id: 3, membership_type: 'participant', can_edit: false, is_active: false },
-        { membership_id: 5, user_id: 4, grouping_id: 4, membership_type: 'participant', can_edit: false, is_active: true },
-        { membership_id: 6, user_id: 2, grouping_id: 4, membership_type: 'participant', can_edit: false, is_active: false },
-        { membership_id: 7, user_id: 3, grouping_id: 5, membership_type: 'participant', can_edit: false, is_active: true },
-        { membership_id: 8, user_id: 1, grouping_id: 5, membership_type: 'participant', can_edit: false, is_active: true },
+        {
+            membership_id: 1,
+            user_id: 1,
+            grouping_id: 1,
+            membership_type: '_admin',
+            can_edit: true,
+            is_active: true,
+        },
+        {
+            membership_id: 2,
+            user_id: 1,
+            grouping_id: 2,
+            membership_type: 'recruiter',
+            can_edit: true,
+            is_active: true,
+        },
+        {
+            membership_id: 3,
+            user_id: 1,
+            grouping_id: 3,
+            membership_type: 'participant',
+            can_edit: false,
+            is_active: true,
+        },
+        {
+            membership_id: 4,
+            user_id: 2,
+            grouping_id: 3,
+            membership_type: 'participant',
+            can_edit: false,
+            is_active: false,
+        },
+        {
+            membership_id: 5,
+            user_id: 4,
+            grouping_id: 4,
+            membership_type: 'participant',
+            can_edit: false,
+            is_active: true,
+        },
+        {
+            membership_id: 6,
+            user_id: 2,
+            grouping_id: 4,
+            membership_type: 'participant',
+            can_edit: false,
+            is_active: false,
+        },
+        {
+            membership_id: 7,
+            user_id: 3,
+            grouping_id: 5,
+            membership_type: 'participant',
+            can_edit: false,
+            is_active: true,
+        },
+        {
+            membership_id: 8,
+            user_id: 1,
+            grouping_id: 5,
+            membership_type: 'participant',
+            can_edit: false,
+            is_active: true,
+        },
     ],
     groupings: [
-        { grouping_id: 1, grouping_name: '00000000_siimee_', grouping_type: 'company' },
-        { grouping_id: 2, grouping_name: '01010101_testco_', grouping_type: 'company' },
-        { grouping_id: 3, grouping_name: '11111111_usample_fifi', grouping_type: 'match'},
-        { grouping_id: 4, grouping_name: '12121212_archie_fifi', grouping_type: 'match' },
-        { grouping_id: 5, grouping_name: '32323232_mochi_usample', grouping_type: 'match' },
+        {
+            grouping_id: 1,
+            grouping_name: '00000000_siimee_',
+            grouping_type: 'company',
+        },
+        {
+            grouping_id: 2,
+            grouping_name: '01010101_testco_',
+            grouping_type: 'company',
+        },
+        {
+            grouping_id: 3,
+            grouping_name: '11111111_usample_fifi',
+            grouping_type: 'match',
+        },
+        {
+            grouping_id: 4,
+            grouping_name: '12121212_archie_fifi',
+            grouping_type: 'match',
+        },
+        {
+            grouping_id: 5,
+            grouping_name: '32323232_mochi_usample',
+            grouping_type: 'match',
+        },
     ],
     messages: [
         { message_id: 1, user_id: 1, grouping_id: 3, message: 'hello' },
         { message_id: 2, user_id: 2, grouping_id: 3, message: 'hi' },
         { message_id: 3, user_id: 1, grouping_id: 3, message: 'how are you?' },
-        { message_id: 4, user_id: 2, grouping_id: 3, message: 'doing well, and you?' },
+        {
+            message_id: 4,
+            user_id: 2,
+            grouping_id: 3,
+            message: 'doing well, and you?',
+        },
         { message_id: 5, user_id: 1, grouping_id: 3, message: 'doing great' },
         { message_id: 6, user_id: 4, grouping_id: 4, message: 'hey' },
         { message_id: 7, user_id: 5, grouping_id: 4, message: 'just hey?' },
         { message_id: 8, user_id: 1, grouping_id: 5, message: 'hello!' },
-        { message_id: 9, user_id: 3, grouping_id: 5, message: 'meow' }
-    ]
-}
+        { message_id: 9, user_id: 3, grouping_id: 5, message: 'meow' },
+    ],
+}

docs/contents.md

@@ -0,0 +1,37 @@
+# SIIMEE
+
+## Definitions
+
+### User
+A `user` represents a user's account information. It contains their unique identifiers and is required for logging in.
+
+### Profile
+A `profile` is how we link questionaire `responses` to a `user`. 
+
+### Membership
+A `membership` represents how a `user` is connected to `groupings`. 
+
+There should be a `membership` entry referencing every `grouping` a `user` belongs to.
+
+Each `membership` can be marked as active with the `membership.is_active` key. This allows for a history of `memberships` to be persisted, and allows the joining and leaving of `groupings`. Leaving a `grouping` is a matter of marking the `membership.is_active` as `false`.
+
+If the `membership.can_edit` key is true, the `member` `user` is allowed to edit the grouping details.
+
+### Grouping
+A `grouping` is a representation of `membership` between two `profiles`.
+
+Each `grouping` consists of *atleast* two `profiles`.
+
+Some common groupings include: companies and matches
+
+### Messages
+A `message` is the record of a chat message for each `grouping's` chat.
+
+### Responses & Response Keys
+A `response` represents a questionaire *answer* that is linked to a `profile` and ultimately a `user` for scoring and matching. Each `response` references a `response_key`.
+
+A `response_key` represents how each `response` is categorized as well as the actual question asked on the questionaire. 
+
+We group `responses` into broader ctegories to aid scoring.
+
+The `response.response_key_category` is the category and the `response.response_key_prompt` stores the question itself.

frontend/package-lock.json

@@ -8,7 +8,6 @@
       "name": "vite-project",
       "version": "0.0.0",
       "dependencies": {
-        "ajv": "^8.2.0",
         "events": "^3.3.0",
         "joi": "^17.4.0",
         "process": "^0.11.10",
@@ -210,17 +209,6 @@
         "node": ">=0.4.0"
       }
     },
-    "node_modules/ajv": {
-      "version": "8.2.0",
-      "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.2.0.tgz",
-      "integrity": "sha512-WSNGFuyWd//XO8n/m/EaOlNLtO0yL8EXT/74LqT4khdhpZjP7lkj/kT5uwRmGitKEVp/Oj7ZUHeGfPtgHhQ5CA==",
-      "dependencies": {
-        "fast-deep-equal": "^3.1.1",
-        "json-schema-traverse": "^1.0.0",
-        "require-from-string": "^2.0.2",
-        "uri-js": "^4.2.2"
-      }
-    },
     "node_modules/ansi-regex": {
       "version": "2.1.1",
       "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz",
@@ -619,11 +607,6 @@
         "node": ">=0.8.x"
       }
     },
-    "node_modules/fast-deep-equal": {
-      "version": "3.1.3",
-      "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz",
-      "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q=="
-    },
     "node_modules/flatten": {
       "version": "1.0.3",
       "resolved": "https://registry.npmjs.org/flatten/-/flatten-1.0.3.tgz",
@@ -809,11 +792,6 @@
       "integrity": "sha1-Fzb939lyTyijaCrcYjCufk6Weds=",
       "dev": true
     },
-    "node_modules/json-schema-traverse": {
-      "version": "1.0.0",
-      "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz",
-      "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug=="
-    },
     "node_modules/json5": {
       "version": "1.0.1",
       "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz",
@@ -2412,14 +2390,6 @@
       "integrity": "sha512-yYELe9Q5q9IQhuvqsZNwA5hfPkMJ8u92bQLIMcsMxf/VADjNtEYptU+inlufAFYcWdHlwNfZOEnOOQrZrcyJCQ==",
       "dev": true
     },
-    "node_modules/punycode": {
-      "version": "2.1.1",
-      "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz",
-      "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==",
-      "engines": {
-        "node": ">=6"
-      }
-    },
     "node_modules/read-cache": {
       "version": "1.0.0",
       "resolved": "https://registry.npmjs.org/read-cache/-/read-cache-1.0.0.tgz",
@@ -2429,14 +2399,6 @@
         "pify": "^2.3.0"
       }
     },
-    "node_modules/require-from-string": {
-      "version": "2.0.2",
-      "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz",
-      "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==",
-      "engines": {
-        "node": ">=0.10.0"
-      }
-    },
     "node_modules/resolve": {
       "version": "1.20.0",
       "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.20.0.tgz",
@@ -2544,14 +2506,6 @@
       "integrity": "sha1-sxxa6CVIRKOoKBVBzisEuGWnNP8=",
       "dev": true
     },
-    "node_modules/uri-js": {
-      "version": "4.4.1",
-      "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz",
-      "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==",
-      "dependencies": {
-        "punycode": "^2.1.0"
-      }
-    },
     "node_modules/util-deprecate": {
       "version": "1.0.2",
       "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",
@@ -2782,17 +2736,6 @@
       "integrity": "sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==",
       "dev": true
     },
-    "ajv": {
-      "version": "8.2.0",
-      "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.2.0.tgz",
-      "integrity": "sha512-WSNGFuyWd//XO8n/m/EaOlNLtO0yL8EXT/74LqT4khdhpZjP7lkj/kT5uwRmGitKEVp/Oj7ZUHeGfPtgHhQ5CA==",
-      "requires": {
-        "fast-deep-equal": "^3.1.1",
-        "json-schema-traverse": "^1.0.0",
-        "require-from-string": "^2.0.2",
-        "uri-js": "^4.2.2"
-      }
-    },
     "ansi-regex": {
       "version": "2.1.1",
       "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz",
@@ -3108,11 +3051,6 @@
       "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz",
       "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q=="
     },
-    "fast-deep-equal": {
-      "version": "3.1.3",
-      "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz",
-      "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q=="
-    },
     "flatten": {
       "version": "1.0.3",
       "resolved": "https://registry.npmjs.org/flatten/-/flatten-1.0.3.tgz",
@@ -3271,11 +3209,6 @@
       "integrity": "sha1-Fzb939lyTyijaCrcYjCufk6Weds=",
       "dev": true
     },
-    "json-schema-traverse": {
-      "version": "1.0.0",
-      "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz",
-      "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug=="
-    },
     "json5": {
       "version": "1.0.1",
       "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz",
@@ -4654,11 +4587,6 @@
       "integrity": "sha512-yYELe9Q5q9IQhuvqsZNwA5hfPkMJ8u92bQLIMcsMxf/VADjNtEYptU+inlufAFYcWdHlwNfZOEnOOQrZrcyJCQ==",
       "dev": true
     },
-    "punycode": {
-      "version": "2.1.1",
-      "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz",
-      "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A=="
-    },
     "read-cache": {
       "version": "1.0.0",
       "resolved": "https://registry.npmjs.org/read-cache/-/read-cache-1.0.0.tgz",
@@ -4668,11 +4596,6 @@
         "pify": "^2.3.0"
       }
     },
-    "require-from-string": {
-      "version": "2.0.2",
-      "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz",
-      "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw=="
-    },
     "resolve": {
       "version": "1.20.0",
       "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.20.0.tgz",
@@ -4759,14 +4682,6 @@
       "integrity": "sha1-sxxa6CVIRKOoKBVBzisEuGWnNP8=",
       "dev": true
     },
-    "uri-js": {
-      "version": "4.4.1",
-      "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz",
-      "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==",
-      "requires": {
-        "punycode": "^2.1.0"
-      }
-    },
     "util-deprecate": {
       "version": "1.0.2",
       "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",