readme, license, setup scripts for mono repo

Cherry-pick of commit b5377a0 onto dev/4-amethyst

Author: iturgeon

LICENSE

@@ -0,0 +1,46 @@
+# Obojobo Next
+
+Obojobo Next is a modern educational content ecosystem. Obojobo documents are programmable, extend-able, and heavily fortified with data analytics.
+
+Our focus is on making and delivering fantastic learning content to students. Obojobo is not a [Learning Management System](https://en.wikipedia.org/wiki/Learning_management_system). Rather, it's and incredibly powerful content engine for use inside your LMS.
+
+View the [Obojobo Next Documentation](https://ucfopen.github.io/Obojobo-Docs/).
+
+## The Obojobo Mission
+
+To keep our collective efforts aimed in the same direction, we've outlined what we want Obojobo to be:
+
+1. UI/UX focused design that ensures a satisfying & enjoyable student experience.
+2. Low barrier of entry for content creators. Creating content is as easy as writing a document in Word.
+3. Research centric design. Obojobo aims to be the premiere research-enabling learning platform by providing high resolution data, partnering with researchers, and including proven research outcomes back into the platform.
+4. Extraordinary practice and assessment tools that enable emerging teaching and learning models.
+5. Provide innovative new capabilities in online, blended, and mixed mode courses.
+6. Architecturally extensible and modular. Obojobo Next is easy to customize and extend.
+
+## Requirements
+
+* [Node](https://nodejs.org/) & [Yarn](https://yarnpkg.com/)
+* [PosgreSQL](https://www.postgresql.org/) Database
+* [Docker](https://www.docker.com/) (for development)
+
+## Development Setup
+
+1. clone this repo
+2. run `yarn install` to install dependencies
+3. run `yarn setup` runs a basic setup script to build assets and setup a docker database container
+4. run `yarn dev` to start the development express server
+7. visit [https://127.0.0.1:8080](https://127.0.0.1:8080) - You should see "Welcome to Obojobo Next"
+
+> Familiarize yourself with the **scripts** section of package.json.
+
+### Logging in
+
+To view the example object you need to login via an LTI launch. Instructions are available in Obojobo: [https://127.0.0.1:8080/lti](https://127.0.0.1:8080/lti)
+
+### Create New Documents:
+
+Once logged in, visit [https://127.0.0.1:8080/editor](https://127.0.0.1:8080/editor). Click **+ Create New Draft** to get started.
+
+### Testing
+
+`yarn test` or `yarn test:ci`

README.md

@@ -2,6 +2,7 @@
   "private": true,
   "name": "obojobo-next",
   "scripts": {
+    "setup": "cd node_modules/obojobo-document-engine && yarn build && cd ../obojobo-express && yarn db:rebuild",
     "dev": "cd node_modules/obojobo-express && yarn dev",
     "dev:docEngine": "concurrently \"cd node_modules/obojobo-express && yarn dev\" \" cd node_modules/obojobo-document-engine && yarn start\"",
     "test": "cd node_modules/obojobo-document-xml-parser && yarn test && cd ../obojobo-express && yarn test && cd ../obojobo-document-engine && yarn test",

package.json

@@ -1 +1 @@
-This is the draft document viewer for Obojobo Next. Documentation & install instructions for this project can be found at https://github.com/ucfcdl/Obojobo-Next.
+This is the Obojobo Next Document Engine. Documentation for this project can be found at https://github.com/ucfcdl/Obojobo-Next.

packages/obojobo-document-engine/README.md

@@ -1,81 +1 @@
-# Obojobo 3 Server
-
-About this project.
-
-## Requirements
-
-* Node 6
-* Yarn
-* Posgress Database
-* Docker (for development)
-* Nginx (for production)
-
-## Development Setup
-
-The scripts section of package.json will be useful to learn.
-
-1. clone this repo into a directory
-2. run `yarn` to install packages
-3. run `yarn db:initdocker` to create a postgress docker container
-4. run `yarn db:migrateup` to run migrations
-5. run `yarn sampleDraft:seed` to insert a sample document into the database
-6. run `yarn dev` to start the development express server
-7. visit `https://127.0.0.1:8080` - You should see "Welcome to Obojobo Next"
-
-To view the example object you need to create an LTI login. You an use an LTI testing tool for this:
-
-1. Visit `http://ltiapps.net/test/tc.php`
-2. Set the **Launch URL** to `https://127.0.0.1:8080/view/00000000-0000-0000-0000-000000000000`
-3. Set the **Consumer key** to `testkey`
-4. Set the **Shared secret** to `testsecret`
-5. Click **Save Data**
-6. Click **Launch TP in new window**
-
-To create, edit and delete objects:
-
-1. Login as above
-2. Visit `https://127.0.0.1:8080/editor` - You should not see any objects. Click **+ Create New Draft** to get started.
-
-## Developing Obojobo Document Engine
-
-1. run `yarn devDocEngine:setup` to install a dev copy of doc engine
-2. run `yarn devDocEngine:link` to replace the node_modules version with your development Doc Engine located in /devsrc/
-3. run `yarn dev:docEngine` 
-
-## Developing Obojobo XML Parser
-
-1. run `yarn devXmlParser:setup` to install a dev copy of the parser
-2. run `yarn devXmlParser:link` to replace the node_modules version with your development parser located in /devsrc/
-
-## Testing
-
-`yarn test` and `yarn test:ci`
-
-## Production Setup
-
-1. clone this repo into a directory
-2. run `yarn` to install packages
-3. setup your postgress database and add the credentials to `config/db.json`
-4. run `yarn db:migrateup` to run migrations
-5. run `yarn sampleDraft:seed` to insert a sample document into the database
-6. run `yarn assets` to compile the javascript and css assets
-7. run `yarn start` to run the server on port 3000
-8. Set up nginx server to pass requests to the server
-7. visit `https://127.0.0.1:8080/`
-
-## Administration
-
-## Logging with AWS Cloudwatch
-
-* Install https://github.com/jorgebastida/awslogs on your machine
-* Search for a list of log groups you can read: `awslogs groups`
-* Learn about awslogs using `awslogs --help`
-* Logs from the last day: `awslogs get GROUPNAME --start='1d ago'` (Replace `GROUPNAME`)
-* Watch logs: `awslogs get GROUPNAME --watch`
-
-
-## Installing Obojobo Modules
-
-### Adding new ones
-### Blacklisting
-### Express.js
+This is the Obojobo Next Express Server. Documentation for this project can be found at https://github.com/ucfcdl/Obojobo-Next.

packages/obojobo-express/README.MD

@@ -9,9 +9,9 @@
 		"db:reset": "node_modules/.bin/db-migrate reset --config config/db.json",
 		"db:migrateup": "node_modules/.bin/db-migrate up --config config/db.json",
 		"db:migratedown": "node_modules/.bin/db-migrate down --config config/db.json",
-		"db:createmigration": "node_modules/.bin/db-migrate create --config config/db.json",
-		"db:remove": "docker kill db_postgres && docker rm db_postgres",
-		"db:rebuild": "yarn db:remove && yarn db:initdocker && sleep 4 && yarn db:migrateup && yarn sampleDraft:seed",
+		"db:createmigration":"node_modules/.bin/db-migrate create --config config/db.json",
+		"db:remove": "(docker kill db_postgres || true) && (docker rm db_postgres || true)",
+		"db:rebuild":"yarn db:remove && yarn db:initdocker && sleep 4 && yarn db:migrateup && yarn sampleDraft:seed",
 		"sampleDraft:seed": "node ./bin/sample_draft.js seed",
 		"sampleDraft:watch": "node ./bin/sample_draft.js watch",
 		"assets": "yarn assets:docEngine && webpack --mode production --optimize-minimize",

packages/obojobo-express/package.json

@@ -13,12 +13,14 @@
 		<h3>Testing LTI Launch</h3>
 		<ol>
 			<li>Visit the <a href="http://lti.tools/saltire/tc" target="_blank">IMS LTI Tool Consumer Emulator</a></li>
-			<li>Set <b>Message Type</b> to one of:
+			<li>Optional - Select <b>Message</b> on the left side menu</li>
+			<li>Optional - Set <b>Message URL</b> to one of:
 				<ul>
 					<li><code>basic-lti-launch-request</code></li>
 					<li><code>ContentItemSelectionRequest</code></li>
 				</ul>
 			</li>
+			<li>Select <b>Tool Provider</b> on the left side menu</li>
 			<li>Set <b>Message URL</b> to one of:
 				<ul>
 					<li><code><%= launch_url %></code></li>