Merge pull request #17 from alexwohlbruck/develop

Added guide for DIY setup
alexwohlbruck · Jun 14, 2017 · 4f090d6 · 4f090d6
2 parents 72af6a6 + 8e6148c
commit 4f090d6
Show file tree

Hide file tree

Showing 4 changed files with 143 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -14,5 +14,8 @@ Using a combination of [Node.js](https://nodejs.org), [Angular](https://angularj
 - Add recipients by talking to the Catbot!
 - Import all of your Google contacts at once
 
+### Setup
+If you want to set up your own version of Cat Facts, follow the instructions in this [guide](https://github.com/alexwohlbruck/cat-facts/blob/master/SETUP.md)
+
 Visit the site [here](https://cat-fact.herokuapp.com) and start messing with your friends!
 Talk to the API.AI bot [here](https://bot.api.ai/d7b47381-1453-4b31-a20c-9825de80cf88)
diff --git a/SETUP.md b/SETUP.md
@@ -0,0 +1,137 @@
+# How to set up Cat Facts on your own device
+
+##### Requirements:
+- An Android phone with SMS capabilities
+- [Tasker](https://play.google.com/store/apps/details?id=net.dinglisch.android.taskerm) (Android app for automation)
+- [Node.js](https://nodejs.org)
+- [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) for deployment
+
+##### Copy the repository into your workspace:
+1. Clone the repository from GitHub 
+    `git clone https://github.com/alexwohlbruck/cat-facts.git`
+
+2. Install NPM modules
+    `npm install`
+
+##### Set up services and APIs
+
+3. Create your service tokens
+    - Heroku Hosting (Skip this if you want to use your own web hosting)
+        1. Log in or Sign up at https://heroku.com
+        2. Create a new app and name it whatever you like. This name has to be unique and not in use.
+        3. You can either connect the app to a GitHub repository or use Heroku's own Git service via the CLI:
+            - With the Heroku CLI: Follow the instructions on the Deploy tab in Heroku
+            - With Connect to GitHub: Sign into GitHub and pick your repository to connect. Enable auto-deploys if you'd like
+    - Google Developers Platform (For Google Sign in and OAuth)
+        1. Log in to https://console.developers.google.com
+        2. Create a new project and name it "Cat Facts"
+        3. In the Dashboard, click "Enable API". Here you can search for APIs needed for the project
+        4. Enable the Google+ API and the Google People API
+        5. Go the the Credentials section and create an OAuth 2.0 Client ID
+        6. Add the domain name where your project is hosted as an Authorized Javascript Origin, for example:
+            `https://cat-fact.herokuapp.com`
+            If you're using Heroku for hosting, the domain should be `https://your-app-name.herokuapp.com`
+        7. In the Authorized redirect URI's section, add two more URLs with the callback URLS like so:
+            `{https://what-ever-you-used-as-the-domain-above.com}/auth/google/callback`
+            `{https://what-ever-you-used-as-the-domain-above.com}/auth/google/contacts/callback`
+        8. Take note of the Client ID and Client Secret, we'll use them later
+    - IFTTT (Communication from server to your device)
+        1. Download the IFTTT app to your Android phone and sign in
+        2. Connect the Maker Webhooks and Android SMS services to your account
+        3. Add the [CatBot Applet](https://ifttt.com/applets/48787297d-send-catbot-message) and turn it on
+        4. Go to the [Maker Webhooks page](https://ifttt.com/maker_webhooks) and click "Documentation"
+        5. Take note of your service key, displayed at the top
+    - mLab MongoDB database (Skip this if you want to use your own Mongo database)
+        1. Sign up or log in to [mLab](https://mlab.com)
+        2. Create a new database by clicking the "Create new" button
+        3. Choose the AWS Provider and under the Single-node tab, choose the free Sandbox option
+        4. Name your database "cat-facts" and create it
+        5. Open the database and create a user for your database. Remember the username and password (this is different than the user/pass combo you used to login to mLab)
+
+4. Add tokens and other credentials to your config vars
+    - Add the following config variables to your project (In the Settings tab of the Heroku console and in your development environment if you want to use one):
+
+		| Name 					  | Value																							|
+		| ----------------------- | ----------------------------------------------------------------------------------------------- |
+		| BASE_URL               | {Your heroku app's domain name}																	|
+		| DB_USERNAME             | {Your mLab database's user account name}														|
+		| DB_PASSWORD            | {Your mLab database's user account password}														|
+		| ENCRYPTION_ALGORITHM    | `aes-256-ctr`																					|
+		| ENCRYPTION_KEY          | {Generate a key using the password generator}													|
+		| GOOGLE_CLIENT_ID       | {Your Client ID from the Google Developer's Platform												|
+		| GOOGLE_CLIENT_SECRET   | {Your Client Secret from the Google Developer's Platform}										|
+		| IFTTT_API_KEY           | {The service key provided by the IFTTT Maker Webhooks service}									|
+		| NODE_ENV                | {"production" for your heroku config and "development" for your own development environment}	|
+		| SESSION_SECRET          | {Generate a key using the password generator}													|
+		| GENERAL_ACCESS_TOKEN    | {Generate a key using the password generator}													|
+		
+	LastPass Random Password Generator: https://lastpass.com/generatepassword.php
+
+5. Deploy your app
+    1. In the Deploy tab of the Heroku console, re-deploy the app, and check it's status in the Activity tab
+    2. You should be able to visit your Cat-Facts clone at the domain you have been using
+    3. To test that it's working, try to sign in. If all is well, continue to the next step
+
+##### Connect your phone to Cat Facts
+
+6. Set up Tasker automation
+    Tasker is an Android app that can help you automate your phone based on "Profiles" and "Tasks". Download the app to your Android phone and follow the instructions below:
+    1. Create a new Profile by clicking the plus button, and choose Time
+    2. In the "from" section, choose a time for the Cat Facts to send every day. Then disable the "to" option
+    3. Click the back button, and on the next screen click "New Task"
+    4. Name the task "CatBot Many" and click the Check box
+    5. Add the following actions to this task:
+        1. HTTP Get
+            - Server:Port: `{Your heroku app's domain name}`
+            - Path: `/recipients`
+            - Attributes: `code={Your general access token from config vars}`
+        2. JavaScriptlet
+            - Code: 
+	            ```
+	            var data = JSON.parse(global('HTTPD'));
+	            var recipients = data.recipients.join(',');
+	            var fact = data.fact;
+	            setGlobal('DAILYFACT', fact);
+	            setGlobal('RECIPIENTS', recipients);
+	            ```
+        3. For
+            - Variable: `%RECIPIENT`
+            - Items: `%RECIPIENTS`
+        4. Send SMS
+            - Number: `%RECIPIENT`
+            - Message: `%DAILYFACT`
+        5. End For
+    6. Go back to the Profiles tab and create an event based profile for "Recieved Text Any"
+    7. Create a task for this profile called "CatBot Single"
+    8. This task will include these actions:
+        1. HTTP Get
+            - Server:Port: `{Your heroku app's domain name}`
+            - Path: `/facts/text`
+            - Attributes:
+                ```
+                query=%SMSRB
+                number=%SMSRF
+                name=%SMSRN
+                ```
+        2. JavaScriptlet
+            - Code:
+                ```
+                var data = JSON.parse(global('HTTPD'));
+                var response = data.response.text;
+                var delay = data.delay;
+                var number = data.number;
+                setGlobal('DELAY', delay);
+                setGlobal('CATBOTRESPONSE', response);
+                setGlobal('CATBOTRESPONSENUMBER', number);
+                ```
+        3. Wait
+            - Seconds (Click the "shuffle" icon to enter a value): `%DELAY`
+        4. Send SMS
+            - Number: `%CATBOTRESPONSENUMBER`
+            - Message: `%CATBOTRESPONSE`
+    9. Click the back button and exit the app to save changes
+    10. To test if Tasker is working, open the "CatBot Many" task and click the green arrow to run it. Cat Facts should be sent to all the recipients that are saved in your database
+
+##### That's it!
+
+And in those few easy steps (lolwut), you should have a clone of the Cat Facts codebase and you can now make any changes that your heart desires.
diff --git a/app/config/keys.js b/app/config/keys.js
@@ -17,5 +17,6 @@ module.exports = {
     database: {
         username: process.env.DB_USERNAME,
         password: process.env.DB_PASSWORD
-    }
+    },
+    generalAccessToken: process.env.GENERAL_ACCESS_TOKEN
 };
diff --git a/app/routes/recipient.routes.js b/app/routes/recipient.routes.js
@@ -14,7 +14,7 @@ var IFTTTService = require.main.require('./app/services/ifttt.service.js');
 
 // (Tasker route) Get all recipients and a fact to be sent out each day
 router.get('/', function(req, res) {
-	if (req.query && req.query.code == keys.dbPassword) {
+	if (req.query && req.query.code == keys.generalAccessToken) {
 		var io = req.app.get('socketio'), snowball = {};
 
 		bluebird.all([