Improving resources

.gitignore

@@ -0,0 +1 @@
+.DS_Store

README.md

@@ -0,0 +1,69 @@
+# Development Info
+
+All of the code for the project is current in the `survey-app` folder. This project is built using [KeystoneJS](https://keystonejs.com/). More specifically it uses [Node.js](https://nodejs.org/en/), [MongoDB](https://www.mongodb.com/what-is-mongodb), [Express](https://expressjs.com/), [Pug](https://pugjs.org/api/getting-started.html), [Stylus](http://stylus-lang.com/) and [Bootstrap](https://getbootstrap.com/).
+
+## Dependencies
+* Node.js / npm
+  * https://nodejs.org/en/download/
+* MongoDB
+  * Mac: `brew install mongodb`
+  * [Windows](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/)
+  * If this is your first time using MongoDB, you will also need to set up a `/data/db` directory with the correct permissions.
+    * [Mac and Windows Examples](https://stackoverflow.com/questions/41420466/mongodb-shuts-down-with-code-100)
+
+## Set up
+* Clone the repository   
+
+  ```
+  git clone https://github.com/will-saunders/BCAT.git
+  cd BCAT/survey-app
+  npm install
+  ```
+* Create a `.env` file with a cookie secret:   
+
+  ```
+  echo "COOKIE_SECRET=<a_bunch_of_characters>" > .env
+  ```
+  For now, `<a_bunch_of_characters>` can be whatever you'd like.  
+
+* In a separate terminal start mongodb: `mongod`
+* Run `npm start`
+* Check `localhost:3000`
+* Login to the admin page with username: `user@keystonejs.com` and password: `pass`
+* Debugging should work out of the box with VSCode
+
+## Structure
+```
+BCAT/survey-app
+|-- models
+|-- public
+    |-- styles
+        |-- site
+            |-- _layout.styl
+            |-- _variables.styl
+|-- routes
+    |-- index.js
+    |-- middleware.js
+    |-- views
+|-- templates
+    |-- views
+```
+* models
+  * this is where MongoDB models are defined, using [keystone field types](https://keystonejs.netlify.com/api/field/)
+* public/styles/site
+  * `_layout.styl` and `_variables.styl` are the stylus files to override bootstrap defaults.
+  * `site.css` and `site.styl` are generated, so any changes you make to them will be overwritten
+* routes
+  * this is the folder for express routing
+  * new routes are added to `routes/index.js`
+  * code for handling each new route should go under `routes/views/<your_view>.js`
+  * to create a variable that's accessible by a pug template, save it as `locals.varname`, which will be `varname` in the pug template
+* templates
+  * this is the folder for pug templates
+  * code for new pages go under `templates/views/<your_view>.pug`
+
+## Resources
+[Keystone Demo](http://demo.keystonejs.com/)  
+[Keystone Demo Repo](https://github.com/keystonejs/keystone-demo)  
+[Keystone DB Documentation](https://keystonejs.netlify.com/documentation/database/)  
+[Throttling Network w/Chrome DevTools](https://developers.google.com/web/tools/chrome-devtools/network-performance/network-conditions)

survey-app/.gitignore

@@ -29,3 +29,6 @@ node_modules
 
 # Ignore .DS_Store files on OS X
 .DS_Store
+
+# Ignore editor specific files
+.vscode

survey-app/TODOs.md

@@ -0,0 +1,39 @@
+# TODO's for BCAT
+
+### Team lead functionality:
+* Create users 
+* Assign modules to individual users
+* See module completion from their team (through the dashboard, Alia has designs)
+* Add messages to bulletin board that will be visible to everybody on their team 
+
+### Answering Quizzes: 
+* Participants should be able to mark their quiz as complete
+* Make it more obvious to participants that they need to **SEND** their quiz
+* Assign localstorage bcat responses by bcat + userID
+
+### Allow participants to join teams
+~~* Participants should be able to filter down teams to their own state, and then choose their specific team~~    
+
+### Dashboard
+* Dashboard for participant - see progress of their own modules/quizzes, and bulletin board that's updated by team lead 
+* Dashboard for team lead - see progress of their team for assigned modules/quizzes, and set messages to be shown on the team bulletin board  
+
+### Assessment
+* KAP to finalized assessment questions
+* Alia to convert to JSON
+
+### Reports
+* KAP and Alia to create set of dummy responses
+* Mock up Report
+* Develop set of Recommended Actions 
+-- If you want to correct data
+-- If you want to identify funding sources
+-- If you want to do a more detailed engineering study
+-- If you want to evaluate technology/business options
+-- If you want to engage partners
+
+### Other
+* Consider developing case studies
+
+### Outreach/Testing
+

survey-app/bin/backupMongo.js

@@ -0,0 +1,131 @@
+#!/usr/bin/env node
+
+const backup = require('mongodb-backup');
+const fs = require('fs');
+
+const BoxSDK = require('box-node-sdk');
+
+// Create new Box SDK instance
+const sdk = new BoxSDK({
+	clientID: process.env.BOX_CLIENT_ID,
+	clientSecret: process.env.BOX_CLIENT_SECRET,
+
+});
+
+// Create new basic client with developer token
+const client = sdk.getBasicClient(process.env.BOX_DEV_TOKEN);
+const folderId = '58640691930';
+
+async function runBackup() {
+	await backup({
+
+		uri: process.env.MONGODB_URI,
+		root: __dirname + "/", // write files into this dir
+		tar: 'dump-me.tar',
+		callback: function(err) {
+			if (err) {
+				throw err
+			} else {
+				console.log('successfully backed up to ' + __dirname + 'dump-me.tar');
+			}
+		}
+	});
+}
+
+function uploadBackup() {
+	// Set upload values
+	let filePath = __dirname + '/dump-me.tar';
+	let fileName = 'mongo-backup.tar';
+
+	// Create file upload stream
+	const stream = fs.createReadStream(filePath);
+
+	// Upload file
+	return client.files.uploadFile(
+		folderId,
+		fileName,
+		stream,
+		function(err, res) {
+			if (err) {
+				throw err
+			} else {
+				console.log("successful upload");
+			}
+		}
+	);
+}
+
+
+async function getBackupIds() {
+	let ids = {};
+	await client.folders.getItems(folderId, {}, function(err, res){
+		if (err) {
+			console.log("error", err);
+			ids.error = err
+		} else {
+			// console.log("response", res);
+			res.entries.forEach(function(file){
+				console.log("ENTRIES!!!!!", file.id);
+				if (file.name === "mongo-backup.tar") {
+					ids.currentBackup = file.id;
+				} else if (file.name === "mongo-backup-backup.tar") {
+					ids.previousBackup = file.id;
+				} else {
+					console.log("inconsequential: ", file.name)
+				}
+			});
+			// console.log("IDS", ids);
+		}
+	});
+	// console.log("IDS!!!!!!!!!!!!!!!!!!!", ids);
+	return ids
+}
+
+async function moveAroundOldData() {
+	let hope = await getBackupIds(); 
+	if (hope.error) {
+		console.log("there was an error getting ids", hope.error);
+		throw hope.error
+	}
+	// if everything went swimmingly, delete old backup
+	// console.log("backup", hope);
+	if (hope.previousBackup) {
+		console.log("deleting previous backup");
+		await client.files.delete(hope.previousBackup, function(err){
+			if (err) {
+				console.log("oh newwwwww", err);
+				throw err;
+			}
+		});
+	}
+	// move "current" backup to previous backup 
+	if (hope.currentBackup) {
+		console.log("moving mongo-backup to mongo-backup-backup");
+		await client.files.update(hope.currentBackup, {name: "mongo-backup-backup.tar"}
+		).then((resp) => {
+			console.log("updated", resp.id, resp.name)
+		}).catch(err => {
+			console.log("error occurred!", err);
+			throw err;
+		})
+	}
+}
+
+if (module === require.main) {
+	// create new mongo backup tar 
+	runBackup().then(() => {
+		// copy mongo-backup.tar to mongo-backup-backup.tar, delete old mongo-backup-backup
+		moveAroundOldData().then(() => {
+			// upload new mongo-backup.tar
+			uploadBackup().catch(err => {
+				console.error("unable to upload new backup", err)
+			})
+		}).catch(err => {
+			console.error("unable to remove old backup: ", err)
+		});
+	}).catch(err => {
+		console.error("unable to create backup: ", err)
+	})
+
+}
+

survey-app/bin/restoreMongo.js

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+
+const restore = require('mongodb-restore');
+
+restore({
+	uri: process.env.MONGODB_URI,
+	root: __dirname,
+	tar: 'mongo-backup.tar',
+});

survey-app/keystone.js

@@ -3,7 +3,7 @@
 require('dotenv').config();
 
 // Require keystone
-var keystone = require('keystone');
+const keystone = require('keystone');
 
 // Initialise Keystone with your project's configuration.
 // See http://keystonejs.com/guide/config for available options
@@ -41,14 +41,16 @@ keystone.set('locals', {
 // Load your project's Routes
 keystone.set('routes', require('./routes'));
 
+// Set login image
+keystone.set('signin logo', '../images/BCATlogo.svg');
+keystone.set('signin redirect', '/home');
+keystone.set('signout redirect', '/');
 
 // Configure the navigation bar in Keystone's Admin UI
 keystone.set('nav', {
-	users: 'users',
+	users: ['users', 'teams', 'roles'],
+	modules: ['modules', 'questions']
 });
 
 // Start Keystone to connect to your database and initialise the web server
-
-
-
 keystone.start();

survey-app/models/Answer.js

@@ -0,0 +1,13 @@
+const keystone = require('keystone');
+const Types = keystone.Field.Types;
+
+const Answer = new keystone.List('Answer', {track: {updatedAt: true}});
+
+Answer.add({
+    userId: { type: Types.Relationship, ref: 'User', initial: true, required: true },
+    moduleId: { type: Types.Relationship, ref: 'Module',initial: true, required: true },
+    questionId: { type: Types.Relationship, ref: 'Question', initial: true, required: true },
+    answer: { type: Types.TextArray }
+});
+
+Answer.register();

survey-app/models/Module.js

@@ -0,0 +1,21 @@
+const keystone = require('keystone');
+const Types = keystone.Field.Types;
+
+const Module = new keystone.List('Module', {
+	autokey: { from: 'name', path: 'key', unique: true },
+	label: 'Modules',
+});
+
+Module.add({
+	name: { type: String, required: true },
+	rank: { type: Number, required: true, initial: true},
+	resources: {type: Types.TextArray}
+});
+
+Module.relationship({ ref: 'Question', refPath: 'module' });
+Module.relationship({ ref: 'Answer', refPath: 'moduleId'});
+Module.relationship({ ref: 'ModuleProgress', refPath: 'moduleId'});
+Module.relationship({ ref: 'User', refPath: 'assignedModules'});
+Module.relationship({ ref: 'Role', refPath: 'modules'});
+
+Module.register();

survey-app/models/ModuleProgress.js

@@ -0,0 +1,13 @@
+const keystone = require('keystone');
+const Types = keystone.Field.Types;
+
+const ModuleProgress = new keystone.List('ModuleProgress', {track: {updatedAt: true}});
+
+ModuleProgress.add({
+	userId: { type: Types.Relationship, ref: 'User', initial: true, required: true },
+	moduleId: { type: Types.Relationship, ref: 'Module',initial: true, required: true },
+	progress: { type: Types.Select, options: [{value: 'IN_PROGRESS', label: 'In Progress'}, {value: 'COMPLETE', label: 'Complete'}, {value: 'NOT_STARTED', label: 'Not Started'}]}, 
+	percentage: { type: Types.Number }
+});
+
+ModuleProgress.register();

survey-app/models/Question.js

@@ -0,0 +1,20 @@
+const keystone = require('keystone');
+const Types = keystone.Field.Types;
+
+/**
+ * Question Model
+ * ==========
+ */
+const Question = new keystone.List('Question');
+
+Question.add({
+    name: { type: Types.Text, initial: true, required: true},
+    question: { type: Types.Text, initial: true, required: true },
+    type: { type: Types.Select, options:['Checkboxes', 'Radio', 'Textarea', 'Scale', 'Info'], default:'Radio', intial: true, required: true },
+    module: { type: Types.Relationship, ref: 'Module'},
+    answers: { type: Types.TextArray }
+});
+
+Question.relationship({ ref: 'Answer', refPath: 'questionId'});
+
+Question.register();