Merge branch 'release/v4.0.0'

.angular-cli.json

@@ -41,13 +41,16 @@
   },
   "lint": [
     {
-      "project": "src/tsconfig.app.json"
+      "project": "src/tsconfig.app.json",
+      "exclude": "**/node_modules/**"
     },
     {
-      "project": "src/tsconfig.spec.json"
+      "project": "src/tsconfig.spec.json",
+      "exclude": "**/node_modules/**"
     },
     {
-      "project": "e2e/tsconfig.e2e.json"
+      "project": "e2e/tsconfig.e2e.json",
+      "exclude": "**/node_modules/**"
     }
   ],
   "test": {

README.md

@@ -26,22 +26,28 @@ Twig is a browser-based single-page application using [D3](https://d3js.org/) to
 
 ## Quick Start
 
-Twig relies on a local copy of [Twig API](https://github.com/buildit/twig-api). Please install Twig API prior installing Twig.
-
-Install of the dependencies
+Clone the [Twig API](https://github.com/buildit/twig-api) locally. From the twig-api root run a Docker command to
+create the back-end.
 
 ```Shell
-npm install
+git clone git@github.com:buildit/twig-api.git
+cd twig-api
+docker-compose up
+
+# Make sure to run `docker-compose down` to turn off the API when you're done
 ```
 
-Then, serve the app
+Clone this repo. Set the proper Node version ([Node Version Manager](https://github.com/creationix/nvm) is recommended). 
+Navigate to the root and install the dependencies. Then run the app.
 
 ```Shell
+nvm use
+npm install
 npm run serve
 ```
 
-This builds the app and runs it on a dev server. Navigate to [localhost:4200](http://localhost:4200/). The app will automatically reload if you change any of the source files.
-
+This builds the app and runs it on a dev server. Navigate to [localhost:4200](http://localhost:4200/). 
+The app will automatically reload if you change any of the source files.
 
 ## Why Twig?
 

e2e/PageObjects/user/index.ts

@@ -44,7 +44,8 @@ export class User {
     });
   }
 
-  loginDefaultTestUser() {
+  // @TODO Any type set since Promise type is resolving as PromiseLike and causing a TypeScript compile error
+  loginDefaultTestUser(): any {
     return this.login(localEmail, localPassword);
   }
 

e2e/tsconfig.e2e.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../out-tsc/e2e",
+    "baseUrl": "./",
+    "module": "commonjs",
+    "target": "es5",
+    "types": [
+      "jasmine",
+      "jasminewd2",
+      "node"
+    ]
+  }
+}