diff --git a/packages/docs/pages/build-integrations/actions.md b/packages/docs/pages/build-integrations/actions.md index 02ac6075..2895ff63 100644 --- a/packages/docs/pages/build-integrations/actions.md +++ b/packages/docs/pages/build-integrations/actions.md @@ -1,5 +1,19 @@ # Actions +:::info + +The build integrations section is best understood when read from beginning to end. To get the most value out of it, start from the first page and read through page by page. + +1. [Folder structure](/build-integrations/folder-structure) +2. [App](/build-integrations/app) +3. [Global variable](/build-integrations/global-variable) +4. [Auth](/build-integrations/auth) +5. [Triggers](/build-integrations/triggers) +6. [Actions](/build-integrations/actions) +7. [Examples](/build-integrations/examples) + +::: + ## Add actions to the app. Open the thecatapi/index.ts file and add the highlighted lines for actions. diff --git a/packages/docs/pages/build-integrations/app.md b/packages/docs/pages/build-integrations/app.md index 777189f0..98643438 100644 --- a/packages/docs/pages/build-integrations/app.md +++ b/packages/docs/pages/build-integrations/app.md @@ -1,5 +1,19 @@ # App +:::info + +The build integrations section is best understood when read from beginning to end. To get the most value out of it, start from the first page and read through page by page. + +1. [Folder structure](/build-integrations/folder-structure) +2. [App](/build-integrations/app) +3. [Global variable](/build-integrations/global-variable) +4. [Auth](/build-integrations/auth) +5. [Triggers](/build-integrations/triggers) +6. [Actions](/build-integrations/actions) +7. [Examples](/build-integrations/examples) + +::: + Let's start building our first app by using [TheCatApi](https://thecatapi.com/) service. It's a service that provides cat images and allows you to vote or favorite a specific cat image. It's an excellent example to demonstrate how Automatisch works with an API that has authentication and data fetching with pagination. We will build an app with the `Search cat images` trigger and `Mark the cat image as favorite` action. So we will learn how to build both triggers and actions. diff --git a/packages/docs/pages/build-integrations/auth.md b/packages/docs/pages/build-integrations/auth.md index 1c5ec9b9..bce7b572 100644 --- a/packages/docs/pages/build-integrations/auth.md +++ b/packages/docs/pages/build-integrations/auth.md @@ -1,5 +1,19 @@ # Auth +:::info + +The build integrations section is best understood when read from beginning to end. To get the most value out of it, start from the first page and read through page by page. + +1. [Folder structure](/build-integrations/folder-structure) +2. [App](/build-integrations/app) +3. [Global variable](/build-integrations/global-variable) +4. [Auth](/build-integrations/auth) +5. [Triggers](/build-integrations/triggers) +6. [Actions](/build-integrations/actions) +7. [Examples](/build-integrations/examples) + +::: + ## Sign up for the cat API Go to the [sign up page](https://thecatapi.com/signup) of the cat API and register your account. It allows you to have 10k requests per month with a free account. You will get an API key by email after the registration. We will use this API key for authentication later on. diff --git a/packages/docs/pages/build-integrations/examples.md b/packages/docs/pages/build-integrations/examples.md index af0ca661..4b44d46a 100644 --- a/packages/docs/pages/build-integrations/examples.md +++ b/packages/docs/pages/build-integrations/examples.md @@ -1,5 +1,19 @@ # Examples +:::info + +The build integrations section is best understood when read from beginning to end. To get the most value out of it, start from the first page and read through page by page. + +1. [Folder structure](/build-integrations/folder-structure) +2. [App](/build-integrations/app) +3. [Global variable](/build-integrations/global-variable) +4. [Auth](/build-integrations/auth) +5. [Triggers](/build-integrations/triggers) +6. [Actions](/build-integrations/actions) +7. [Examples](/build-integrations/examples) + +::: + ## Authentication ### 3-legged OAuth diff --git a/packages/docs/pages/build-integrations/folder-structure.md b/packages/docs/pages/build-integrations/folder-structure.md index 0a34da82..5a84ac35 100644 --- a/packages/docs/pages/build-integrations/folder-structure.md +++ b/packages/docs/pages/build-integrations/folder-structure.md @@ -1,5 +1,19 @@ # Folder Structure +:::info + +The build integrations section is best understood when read from beginning to end. To get the most value out of it, start from the first page and read through page by page. + +1. [Folder structure](/build-integrations/folder-structure) +2. [App](/build-integrations/app) +3. [Global variable](/build-integrations/global-variable) +4. [Auth](/build-integrations/auth) +5. [Triggers](/build-integrations/triggers) +6. [Actions](/build-integrations/actions) +7. [Examples](/build-integrations/examples) + +::: + :::warning We will use the terms **integration** and **app** interchangeably in this document. ::: diff --git a/packages/docs/pages/build-integrations/global-variable.md b/packages/docs/pages/build-integrations/global-variable.md index a3bff21c..3c7b5cfe 100644 --- a/packages/docs/pages/build-integrations/global-variable.md +++ b/packages/docs/pages/build-integrations/global-variable.md @@ -1,5 +1,19 @@ # Global Variable +:::info + +The build integrations section is best understood when read from beginning to end. To get the most value out of it, start from the first page and read through page by page. + +1. [Folder structure](/build-integrations/folder-structure) +2. [App](/build-integrations/app) +3. [Global variable](/build-integrations/global-variable) +4. [Auth](/build-integrations/auth) +5. [Triggers](/build-integrations/triggers) +6. [Actions](/build-integrations/actions) +7. [Examples](/build-integrations/examples) + +::: + Before handling authentication and building a trigger and an action, it's better to explain the `global variable` concept in Automatisch. Automatisch provides you the global variable that you need to use with authentication, triggers, action, and basically all the stuff you will build for the integration. The global variable is represented as `$` variable in the codebase, and it's a JSON object that contains the following properties: diff --git a/packages/docs/pages/build-integrations/triggers.md b/packages/docs/pages/build-integrations/triggers.md index 061a228c..f7c0f7bc 100644 --- a/packages/docs/pages/build-integrations/triggers.md +++ b/packages/docs/pages/build-integrations/triggers.md @@ -1,5 +1,19 @@ # Triggers +:::info + +The build integrations section is best understood when read from beginning to end. To get the most value out of it, start from the first page and read through page by page. + +1. [Folder structure](/build-integrations/folder-structure) +2. [App](/build-integrations/app) +3. [Global variable](/build-integrations/global-variable) +4. [Auth](/build-integrations/auth) +5. [Triggers](/build-integrations/triggers) +6. [Actions](/build-integrations/actions) +7. [Examples](/build-integrations/examples) + +::: + ## Add triggers to the app Open the `thecatapi/index.ts` file and add the highlighted lines for triggers.