groot/automatisch
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add content table for build integration pages

Browse Source
This commit is contained in:
Faruk AYDIN
2022-11-08 20:12:25 +01:00
parent 47afd60ddf
commit c579eebd16
7 changed files with 98 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
packages/docs/pages/build-integrations/actions.md
View File

@@ -1,5 +1,19 @@
# Actions # 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. [<mark>Actions</mark>](/build-integrations/actions)
7. [Examples](/build-integrations/examples)
:::
## Add actions to the app. ## Add actions to the app.
Open the thecatapi/index.ts file and add the highlighted lines for actions. Open the thecatapi/index.ts file and add the highlighted lines for actions.

14
packages/docs/pages/build-integrations/app.md
View File

@@ -1,5 +1,19 @@
# App # 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. [<mark>App</mark>](/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. 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. 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.

14
packages/docs/pages/build-integrations/auth.md
View File

@@ -1,5 +1,19 @@
# Auth # 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. [<mark>Auth</mark>](/build-integrations/auth)
5. [Triggers](/build-integrations/triggers)
6. [Actions](/build-integrations/actions)
7. [Examples](/build-integrations/examples)
:::
## Sign up for the cat API ## 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. 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.

14
packages/docs/pages/build-integrations/examples.md
View File

@@ -1,5 +1,19 @@
# Examples # 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. [<mark>Examples</mark>](/build-integrations/examples)
:::
## Authentication ## Authentication
### 3-legged OAuth ### 3-legged OAuth

14
packages/docs/pages/build-integrations/folder-structure.md
View File

@@ -1,5 +1,19 @@
# Folder Structure # 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. [<mark>Folder structure</mark>](/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 :::warning
We will use the terms **integration** and **app** interchangeably in this document. We will use the terms **integration** and **app** interchangeably in this document.
::: :::

14
packages/docs/pages/build-integrations/global-variable.md
View File

@@ -1,5 +1,19 @@
# Global Variable # 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. [<mark>Global variable</mark>](/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. 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: The global variable is represented as `$` variable in the codebase, and it's a JSON object that contains the following properties:

14
packages/docs/pages/build-integrations/triggers.md
View File

@@ -1,5 +1,19 @@
# Triggers # 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. [<mark>Triggers</mark>](/build-integrations/triggers)
6. [Actions](/build-integrations/actions)
7. [Examples](/build-integrations/examples)
:::
## Add triggers to the app ## Add triggers to the app
Open the `thecatapi/index.ts` file and add the highlighted lines for triggers. Open the `thecatapi/index.ts` file and add the highlighted lines for triggers.