GitBook: [#13] No subject

friggframework · May 27, 2022 · 5b7d7ee · 5b7d7ee
1 parent 76d97a6
commit 5b7d7ee
Show file tree

Hide file tree

Showing 37 changed files with 119 additions and 37 deletions.
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -3,15 +3,14 @@
 ## 🥳 Getting Started
 
 * [Introduction](README.md)
-* [Quick Start Tutorial](getting-started/quick-start/README.md)
+* [Quick Start Tutorial](getting-started/quick-start.md)
   * [Create Frigg App](getting-started/quick-start/create-frigg-app.md)
   * [Exploring the App](getting-started/quick-start/exploring-the-app.md)
   * [Connecting to the Database](getting-started/quick-start/connecting-to-the-database.md)
   * [Installing an API Module](getting-started/quick-start/installing-an-api-module.md)
   * [Building your first integration](getting-started/quick-start/building-your-first-integration.md)
   * [Testing the Integration](getting-started/quick-start/testing-the-integration.md)
   * [Next Steps](getting-started/quick-start/next-steps.md)
-* [Authentication](getting-started/authentication.md)
 
 ## 👩💻 Development
 
@@ -25,6 +24,8 @@
     * [Testing](development/api-module-development-guide/deployment/testing.md)
     * [Publishing](development/api-module-development-guide/deployment/publishing.md)
     * [Extending](development/api-module-development-guide/deployment/extending.md)
+* [Integration Development Guide](development/integration-development-guide.md)
+* [Authentication](development/authentication.md)
 * [Contributing](development/contributing/README.md)
   * [Contributor Covenant Code of Conduct](development/contributing/code\_of\_conduct.md)
   * [PULL\_REQUEST\_TEMPLATE](development/contributing/pull\_request\_template.md)
@@ -39,29 +40,29 @@
 * [Overview](api-modules/overview.md)
 * [Building Your Own Module](api-modules/building-your-own-module.md)
 * [Module List](api-modules/module-list/README.md)
-  * [ActiveCampaign](api-modules/module-list/activecampaign/README.md)
-    * [Configuration](api-modules/module-list/activecampaign/configuration.md)
+  * [ActiveCampaign](api-modules/activecampaign/README.md)
+    * [Configuration](api-modules/activecampaign/configuration.md)
     * [ActiveCampaign Docs](https://developers.activecampaign.com/reference/overview)
-  * [Monday.com](api-modules/module-list/monday.com/README.md)
-    * [Configuration](api-modules/module-list/monday.com/configuration.md)
+  * [Monday.com](api-modules/monday.com/README.md)
+    * [Configuration](api-modules/monday.com/configuration.md)
     * [Monday.com Docs](https://apps.developer.monday.com/docs)
-  * [Rev.io](api-modules/module-list/rev.io/README.md)
-    * [Configuration](api-modules/module-list/rev.io/configuration.md)
-  * [ConnectWise](api-modules/module-list/connectwise/README.md)
-    * [Configuration](api-modules/module-list/connectwise/configuration.md)
-  * [RollWorks](api-modules/module-list/rollworks/README.md)
-    * [Configuration](api-modules/module-list/rollworks/configuration.md)
-  * [Salesforce](api-modules/module-list/salesforce/README.md)
-    * [Configuration](api-modules/module-list/salesforce/configuration.md)
-  * [Salesloft](api-modules/module-list/salesloft/README.md)
-    * [Configuration](api-modules/module-list/salesloft/configuration.md)
-  * [Fastspring](api-modules/module-list/fastspring/README.md)
-    * [Configuration](api-modules/module-list/fastspring/configuration.md)
-  * [Attentive](api-modules/module-list/attentive/README.md)
-    * [Configuration](api-modules/module-list/attentive/configuration.md)
+  * [Rev.io](api-modules/rev.io/README.md)
+    * [Configuration](api-modules/rev.io/configuration.md)
+  * [ConnectWise](api-modules/connectwise/README.md)
+    * [Configuration](api-modules/connectwise/configuration.md)
+  * [RollWorks](api-modules/rollworks/README.md)
+    * [Configuration](api-modules/rollworks/configuration.md)
+  * [Salesforce](api-modules/salesforce/README.md)
+    * [Configuration](api-modules/salesforce/configuration.md)
+  * [Salesloft](api-modules/salesloft/README.md)
+    * [Configuration](api-modules/salesloft/configuration.md)
+  * [Fastspring](api-modules/fastspring/README.md)
+    * [Configuration](api-modules/fastspring/configuration.md)
+  * [Attentive](api-modules/attentive/README.md)
+    * [Configuration](api-modules/attentive/configuration.md)
     * [Attentive Docs](https://docs.attentivemobile.com)
-  * [Hubspot](api-modules/module-list/hubspot/README.md)
-    * [Configuration](api-modules/module-list/hubspot/configuration.md)
+  * [Hubspot](api-modules/hubspot/README.md)
+    * [Configuration](api-modules/hubspot/configuration.md)
     * [Hubspot Docs](https://developers.activecampaign.com/reference/overview)
 
 ## 📞 Support

diff --git a/...ules/module-list/activecampaign/README.md → docs/api-modules/activecampaign/README.md b/...ules/module-list/activecampaign/README.md → docs/api-modules/activecampaign/README.md
@@ -1 +1,2 @@
 # ActiveCampaign
+
diff --git a/.../module-list/connectwise/configuration.md → ...i-modules/activecampaign/configuration.md b/.../module-list/connectwise/configuration.md → ...i-modules/activecampaign/configuration.md
@@ -1 +1,2 @@
 # Configuration
+
diff --git a/...i-modules/module-list/attentive/README.md → docs/api-modules/attentive/README.md b/...i-modules/module-list/attentive/README.md → docs/api-modules/attentive/README.md
@@ -1 +1,2 @@
 # Attentive
+
diff --git a/...dule-list/activecampaign/configuration.md → docs/api-modules/attentive/configuration.md b/...dule-list/activecampaign/configuration.md → docs/api-modules/attentive/configuration.md
@@ -1 +1,2 @@
 # Configuration
+
diff --git a/...modules/module-list/connectwise/README.md → docs/api-modules/connectwise/README.md b/...modules/module-list/connectwise/README.md → docs/api-modules/connectwise/README.md
@@ -1 +1,2 @@
 # ConnectWise
+
diff --git a/...s/module-list/fastspring/configuration.md → .../api-modules/connectwise/configuration.md b/...s/module-list/fastspring/configuration.md → .../api-modules/connectwise/configuration.md
@@ -1 +1,2 @@
 # Configuration
+
diff --git a/...-modules/module-list/fastspring/README.md → docs/api-modules/fastspring/README.md b/...-modules/module-list/fastspring/README.md → docs/api-modules/fastspring/README.md
@@ -1 +1,2 @@
 # Fastspring
+
diff --git a/...es/module-list/attentive/configuration.md → docs/api-modules/fastspring/configuration.md b/...es/module-list/attentive/configuration.md → docs/api-modules/fastspring/configuration.md
@@ -1 +1,2 @@
 # Configuration
+
diff --git a/...api-modules/module-list/hubspot/README.md → docs/api-modules/hubspot/README.md b/...api-modules/module-list/hubspot/README.md → docs/api-modules/hubspot/README.md
@@ -1 +1,2 @@
 # Hubspot
+
diff --git a/docs/api-modules/hubspot/configuration.md b/docs/api-modules/hubspot/configuration.md
@@ -0,0 +1,2 @@
+# Configuration
+
diff --git a/docs/api-modules/module-list/hubspot/configuration.md b/docs/api-modules/module-list/hubspot/configuration.md
diff --git a/docs/api-modules/module-list/monday.com/configuration.md b/docs/api-modules/module-list/monday.com/configuration.md
diff --git a/docs/api-modules/module-list/rev.io/configuration.md b/docs/api-modules/module-list/rev.io/configuration.md
diff --git a/docs/api-modules/module-list/rollworks/configuration.md b/docs/api-modules/module-list/rollworks/configuration.md
diff --git a/docs/api-modules/module-list/salesforce/configuration.md b/docs/api-modules/module-list/salesforce/configuration.md
diff --git a/docs/api-modules/module-list/salesloft/configuration.md b/docs/api-modules/module-list/salesloft/configuration.md
diff --git a/...-modules/module-list/monday.com/README.md → docs/api-modules/monday.com/README.md b/...-modules/module-list/monday.com/README.md → docs/api-modules/monday.com/README.md
@@ -1 +1,2 @@
 # Monday.com
+
diff --git a/docs/api-modules/monday.com/configuration.md b/docs/api-modules/monday.com/configuration.md
@@ -0,0 +1,2 @@
+# Configuration
+
diff --git a/docs/api-modules/overview.md b/docs/api-modules/overview.md
@@ -1 +1,8 @@
 # Overview
+
+* Modules power it all
+* Easy to add
+* Easy to contribute to
+* Leverage node-fetch for the most part
+* Uses well-supported sdks only sometimes
+* Can really do whatever you'd like
diff --git a/.../api-modules/module-list/rev.io/README.md → docs/api-modules/rev.io/README.md b/.../api-modules/module-list/rev.io/README.md → docs/api-modules/rev.io/README.md
@@ -1 +1,2 @@
 # Rev.io
+
diff --git a/docs/api-modules/rev.io/configuration.md b/docs/api-modules/rev.io/configuration.md
@@ -0,0 +1,2 @@
+# Configuration
+
diff --git a/...i-modules/module-list/rollworks/README.md → docs/api-modules/rollworks/README.md b/...i-modules/module-list/rollworks/README.md → docs/api-modules/rollworks/README.md
@@ -1 +1,2 @@
 # RollWorks
+
diff --git a/docs/api-modules/rollworks/configuration.md b/docs/api-modules/rollworks/configuration.md
@@ -0,0 +1,2 @@
+# Configuration
+
diff --git a/...-modules/module-list/salesforce/README.md → docs/api-modules/salesforce/README.md b/...-modules/module-list/salesforce/README.md → docs/api-modules/salesforce/README.md
@@ -1 +1,2 @@
 # Salesforce
+
diff --git a/docs/api-modules/salesforce/configuration.md b/docs/api-modules/salesforce/configuration.md
@@ -0,0 +1,2 @@
+# Configuration
+
diff --git a/...i-modules/module-list/salesloft/README.md → docs/api-modules/salesloft/README.md b/...i-modules/module-list/salesloft/README.md → docs/api-modules/salesloft/README.md
@@ -1 +1,2 @@
 # Salesloft
+
diff --git a/docs/api-modules/salesloft/configuration.md b/docs/api-modules/salesloft/configuration.md
@@ -0,0 +1,2 @@
+# Configuration
+
diff --git a/docs/development/authentication.md b/docs/development/authentication.md
@@ -0,0 +1,5 @@
+# Authentication
+
+* Frigg's backend needs to authenticate requests
+* Frigg also needs to identify the user
+* Frigg also needs to be authenticated to your API
diff --git a/docs/development/integration-development-guide.md b/docs/development/integration-development-guide.md
@@ -0,0 +1,23 @@
+# Integration Development Guide
+
+* Integration Lifecycle
+  * Create
+  * Get Config Options
+  * Update
+  * ReceiveNotification
+  * Delete
+* Eventing
+  * Webhooks
+  * User interaction
+  * Polling
+    * Simple
+    * Complex
+  * Scheduled
+* Tying it all together
+* Versioning
+* Migrating users
+* Scaling
+* Long-running processes
+* Syncs
+* Extending UI options
+* Hybrid Integrations
diff --git a/docs/getting-started/authentication.md b/docs/getting-started/authentication.md
diff --git a/docs/getting-started/quick-start/README.md → docs/getting-started/quick-start.md b/docs/getting-started/quick-start/README.md → docs/getting-started/quick-start.md
@@ -15,11 +15,3 @@ You'll need to do the following before continuing:
 ### Overview
 
 Create Frigg App will generate a deployable Frigg application that within a few minutes can be deployed to your own accounts to power integrations for your application. Let's get it going and we'll unpack the "magic" as we go.
-
-
-
-### Exploring the Quick Start app
-
-
-
-![](<../../.gitbook/assets/Screen Shot 2022-04-11 at 10.52.07 AM.png>)
diff --git a/docs/getting-started/quick-start/building-your-first-integration.md b/docs/getting-started/quick-start/building-your-first-integration.md
@@ -1,2 +1,18 @@
 # Building your first integration
 
+* HubSpotIntegrationManager.js
+* `getExample` function, add
+
+```
+const contacts = await this.targetInstance.api.listContacts()
+return contacts.results
+```
+
+* Go to HubSpot, sign up for a developer account
+* Create an Application
+* Navigate to Settings
+* OAuth
+* Copy Client ID and Secret into `/config/dev.json` under `HUBSPOT_CLIENT_ID` and `HUBSPOT_CLIENT_SECRET` respectively
+* Add `http://localhost:3000/redirect/hubspot` to the redirect URI
+* Navigate to backend, run `npm start`
+* Go to the dashboard and reload if you haven't yet. Tada!  Your first integration
diff --git a/docs/getting-started/quick-start/connecting-to-the-database.md b/docs/getting-started/quick-start/connecting-to-the-database.md
@@ -3,3 +3,7 @@
 Frigg has a fairly straightforward data model
 
 ![Frigg Data Model](<../../.gitbook/assets/frigg data model.png>)
+
+* Currently we connect to a MongoDB cluster using Mongoose. Recommendation is MongoDB Atlas, fast and free to spin up a test cluster.
+* Follow instructions to create
+* Copy and paste yours to the `config/dev.json` file
diff --git a/docs/getting-started/quick-start/installing-an-api-module.md b/docs/getting-started/quick-start/installing-an-api-module.md
@@ -1,2 +1,7 @@
 # Installing an API Module
 
+* `npm install @friggframework/api-module-hubspot` in the backend
+* Default display override by adding to ConfigManager
+* Override or add helper functions by creating a HubSpotManager.js in `/managers/entities`
+* Copy over ExampleIntegrationManager.js and corresponding test file
+* Good to go!
diff --git a/docs/getting-started/quick-start/next-steps.md b/docs/getting-started/quick-start/next-steps.md
@@ -1,2 +1,9 @@
 # Next Steps
 
+* Deeper dive into What Makes an Integration
+* Reach out to Left Hook or the community for help!
+* Add your own API Module
+* Integrate Frigg into your existing stack
+* Customize the authentication
+* Add more complexity to your integration
+* Think in categories
diff --git a/docs/getting-started/quick-start/testing-the-integration.md b/docs/getting-started/quick-start/testing-the-integration.md
@@ -1,2 +1,5 @@
 # Testing the Integration
 
+* Mocks
+* proxyquire
+* If you're using queues...