Merge branch 'develop' of https://github.com/openforge/OPENFORGE.IO

Author: PaulPaulDevelops

.firebase/hosting.d3d3.cache

@@ -24,3 +24,5 @@ Thumbs.db
 UserInterfaceState.xcuserstate
 .env
 linters/sass-lint.html
+src/pages/app-blog-post/prerender-blog-data.ts
+src/butter-api/butter-api-key.js

.gitignore

@@ -41,7 +41,7 @@ https://developers.google.com/speed/webp/docs/precompiled
 brew install webp
 ```
 
-#### Make Sure .webp Images are available by running the following commands:
+#### Make Sure .webp Images are available by running the following commands inside the root folder:
 ```
 for file in src/assets/*.jpg; do cwebp -q 75 "$file" -o "${file%.jpg}.webp"; done
 ```
@@ -54,6 +54,28 @@ for file in src/assets/*.png; do cwebp -q 75 "$file" -o "${file%.png}.webp"; don
 for file in src/assets/*.jpeg; do cwebp -q 75 "$file" -o "${file%.jpeg}.webp"; done
 ```
 
+### Blog Setup
+By default, the public version of this project does not contain an API key for the [ButterCMS](https://buttercms.com/) blog content management system. You will need to add your own ButterCMS API key in order to make this project work.
+
+The necessary file for inserting the ButterCMS API key will be auto-generated by running
+```
+node scripts/get-butter.js
+```
+
+After that, use your text editor and open the file:
+```
+src/butter-api/butter-api-key.ts 
+```
+
+and enter your Butter API key between the single quotes '':
+```
+export const BUTTER_API_KEY = '';
+```
+to
+```
+export const BUTTER_API_KEY = 'your API token goes here';
+```
+
 ### Running This Application
 ```
 npm run dev
@@ -116,12 +138,22 @@ For every commit, it will ensure files are linted and that the code is formatted
 
 If a developer went through providing all the information during a `npm run cz` only to find that there were issues with their commit. They may fix them and instruct commitizen to try the commit again with `npm run cz -- --retry`
 
+## Blog Integration
 
-## Deployment
+This project uses [ButterCMS](https://buttercms.com/) as a headless content management system. When a user accesses the deployed site, the blog data will be loaded from the ButterCMS API via AJAX. However, the blog data is also utilized in prerendering the site, to improve SEO. Before any build (dev, prod, prerender), the get-butter.js script is run to retrieve the blog data and stored in pages/blog-post/prerender-blog-data.ts. This file is git-ignored so that the repo is not cluttered with blog content.
+
+The project also utilizes webhooks from [ButterCMS](https://buttercms.com/docs/api/?javascript#webhooks) and [Travis](https://docs.travis-ci.com/user/triggering-builds) to keep the prerendered blog content up to date. Whenever a new blog post is published, Butter's webook invokes the cloud function rebuildMaster, which relays the information to the Travis API, which in turn will trigger a rebuild and redeploy of the master branch. Butter's webhooks are managed in the ButterCMS portal.
 
+### Featured Post
+
+The featured post is managed in the ButterCMS portal. To make a post featured, it must be given a tag of 'featured'. The actual featured post will be the most recently published post with the featured tag. Currently, this post will also appear in the regular list of posts.
+
+
+## Deployment
 ```
 npm run prepublish
 ```
+Note that this will synchronously retrieve the blog post data from Butter CMS before building, so that it can be included in the prerender.
 
 _Note:  You may have to install firebase-tools via ```npm install -g firebase-tools``` and then authenticate via command line on your local machine to firebase_
 

README.md

@@ -6,31 +6,46 @@
       "**/.*",
       "**/node_modules/**"
     ],
-    "headers": [ {
-      "source" : "**/*.@(eot|otf|ttf|ttc|woff|font.css)",
-      "headers" : [ {
-        "key" : "Access-Control-Allow-Origin",
-        "value" : "*"
-      } ]
-    }, {
-      "source" : "**/*.@(jpg|jpeg|gif|png|js)",
-      "headers" : [ {
-        "key" : "Cache-Control",
-        "value" : "max-age=86400"
-      } ]
-    } , {
-    "source" : "**/*.@(js)",
-    "headers" : [ {
-      "key" : "Cache-Control",
-      "value" : "max-age=7200"
-    } ]
-  }],
-    
+    "headers": [
+      {
+        "source": "**/*.@(eot|otf|ttf|ttc|woff|font.css)",
+        "headers": [
+          {
+            "key": "Access-Control-Allow-Origin",
+            "value": "*"
+          }
+        ]
+      },
+      {
+        "source": "**/*.@(jpg|jpeg|gif|png|js)",
+        "headers": [
+          {
+            "key": "Cache-Control",
+            "value": "max-age=86400"
+          }
+        ]
+      },
+      {
+        "source": "**/*.@(js)",
+        "headers": [
+          {
+            "key": "Cache-Control",
+            "value": "max-age=7200"
+          }
+        ]
+      }
+    ],
     "rewrites": [
       {
         "source": "**",
         "destination": "/index.html"
       }
     ]
+  },
+  "functions": {
+    "predeploy": [
+      "npm --prefix \"$RESOURCE_DIR\" run lint",
+      "npm --prefix \"$RESOURCE_DIR\" run build"
+    ]
   }
 }

firebase.json

@@ -0,0 +1,8 @@
+## Compiled JavaScript files
+**/*.js
+**/*.js.map
+
+# Typescript v1 declaration files
+typings/
+
+node_modules/