Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add integration templates #854

Merged
merged 13 commits into from
Jul 27, 2023
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ It is:
- as **flexible** as building integrations yourself
- as **fast** as buying a pre-built solution

Build in hours, instead of weeks with our [production-ready infrastructure](https://docs.nango.dev) and pre-built [integration components for 100+ APIs](https://docs.nango.dev/integrations/overview):
Build in hours, instead of weeks with our [production-ready infrastructure](https://docs.nango.dev) and [pre-built integration components and templates](https://docs.nango.dev/integration-templates/overview) [for 100+ APIs](https://docs.nango.dev/integrations/overview):

- 🔐 Auth for 100+ APIs with 1 line of code
- 🔁 Bi-directional data syncing
Expand Down Expand Up @@ -78,7 +78,7 @@ You can try Nango in 10 minutes with the [Quickstart 🚀](https://nango.dev/qui
Or explore more:

- Understand Nango with the [core concepts](https://docs.nango.dev/core-concepts)
- Learn more about data syncing and unified APIs with [Nango Sync](https://docs.nango.dev/nango-sync)
- Explore the [integration templates](https://docs.nango.dev/integration-templates/overview)
- Explore the [100+ supported APIs](https://nango.dev/integrations)

## 100+ pre-configured APIs, easily add your own
Expand Down Expand Up @@ -110,6 +110,7 @@ If your favorite API is missing
## 🚀 Quickstart

Install nango globally

```
npm install nango -g
```
Expand Down
15 changes: 15 additions & 0 deletions docs-v2/integration-templates/asana.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 'Asana API Integration Template'
sidebarTitle: 'Asana'
---

## Get the template

<Card title="Get it from GitHub"
href="https://github.com/NangoHQ/nango/tree/master/integration-templates/asana"
icon="arrow-right">
Get the latest version of the integration template from GitHub
</Card>

## Need help with the template?
Please reach out on the [Slack community](https://nango.dev/slack), we are very active there and happy to help!
15 changes: 15 additions & 0 deletions docs-v2/integration-templates/github.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 'GitHub API Integration Template'
sidebarTitle: 'GitHub'
---

## Get the template

<Card title="Get it from GitHub"
href="https://github.com/NangoHQ/nango/tree/master/integration-templates/github"
icon="arrow-right">
Get the latest version of the integration template from GitHub
</Card>

## Need help with the template?
Please reach out on the [Slack community](https://nango.dev/slack), we are very active there and happy to help!
15 changes: 15 additions & 0 deletions docs-v2/integration-templates/gmail.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 'Gmail API Integration Template'
sidebarTitle: 'Gmail'
---

## Get the template

<Card title="Get it from GitHub"
href="https://github.com/NangoHQ/nango/tree/master/integration-templates/gmail"
icon="arrow-right">
Get the latest version of the integration template from GitHub
</Card>

## Need help with the template?
Please reach out on the [Slack community](https://nango.dev/slack), we are very active there and happy to help!
15 changes: 15 additions & 0 deletions docs-v2/integration-templates/google-workspace.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 'Google Workspace API Integration Template'
sidebarTitle: 'Google Workspace'
---

## Get the template

<Card title="Get it from GitHub"
href="https://github.com/NangoHQ/nango/tree/master/integration-templates/google-workspace"
icon="arrow-right">
Get the latest version of the integration template from GitHub
</Card>

## Need help with the template?
Please reach out on the [Slack community](https://nango.dev/slack), we are very active there and happy to help!
15 changes: 15 additions & 0 deletions docs-v2/integration-templates/jira.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 'Jira API Integration Template'
sidebarTitle: 'Jira'
---

## Get the template

<Card title="Get it from GitHub"
href="https://github.com/NangoHQ/nango/tree/master/integration-templates/jira"
icon="arrow-right">
Get the latest version of the integration template from GitHub
</Card>

## Need help with the template?
Please reach out on the [Slack community](https://nango.dev/slack), we are very active there and happy to help!
15 changes: 15 additions & 0 deletions docs-v2/integration-templates/linear.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 'Linear API Integration Template'
sidebarTitle: 'Linear'
---

## Get the template

<Card title="Get it from GitHub"
href="https://github.com/NangoHQ/nango/tree/master/integration-templates/linear"
icon="arrow-right">
Get the latest version of the integration template from GitHub
</Card>

## Need help with the template?
Please reach out on the [Slack community](https://nango.dev/slack), we are very active there and happy to help!
15 changes: 15 additions & 0 deletions docs-v2/integration-templates/notion.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 'Notion API Integration Template'
sidebarTitle: 'Notion'
---

## Get the template

<Card title="Get it from GitHub"
href="https://github.com/NangoHQ/nango/tree/master/integration-templates/notion"
icon="arrow-right">
Get the latest version of the integration template from GitHub
</Card>

## Need help with the template?
Please reach out on the [Slack community](https://nango.dev/slack), we are very active there and happy to help!
73 changes: 73 additions & 0 deletions docs-v2/integration-templates/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
title: 'Integration Templates - Overview'
sidebarTitle: 'Overview'
description: 'Do not start from scratch. Use a template.'
---

## Don't start from scratch

Nango lets you build [**any** integration](/core-concepts) with [the 100+ APIs it supports](/integrations/overview).

But nothing beats getting started fast with a pre-built template that you can customize and extend as you wish.

**Templates from the community, for the community**
Anybody can [contribute](/contribute) new integration templates to Nango (just like with the supported APIs).

As the community and Nango grows, we expect to have hundreds of templates and use-cases for hundreds of APIs available for you.

## How to use Integration templates

<Note>
This feature is part of Nango Sync and currently in private beta.
Please reach out on the [Slack community](https://nango.dev/slack) to get access!
</Note>

1. Pull the template with the CLI: `nango pull slack`

2. Modify, extend and customize the template to your needs. Or skip this step.

3. Deploy your new integration to Nango: `nango deploy dev`

4. Nango and the community maintain the templates if the APIs change. If there are changes, just pull them in: `nango pull slack --upgrade`

## Available integration templates

<Tip>
Your favorite API or use-case is missing?
Ping us on the [Slack community](https://nango.dev/slack), we continuously expand the range of templates!
</Tip>

<CardGroup cols={3}>
<Card title="Slack" href="/integration-templates/slack" icon="slack" iconType="brands">
Sync Slack users, channels, messages and reactions
</Card>
<Card title="Salesforce" href="/integration-templates/salesforce" icon="salesforce" iconType="brands">
Sync Salesforce accounts and contacts
</Card>
<Card title="Linear" href="/integration-templates/linear" icon="circle-half-stroke">
Sync Linear issues, projects, roadmaps and teams
</Card>
<Card title="Notion" href="/integration-templates/notion" icon="book">
Sync Notion pages
</Card>
<Card title="Gmail" href="/integration-templates/gmail" icon="envelope">
Sync emails from Gmail
</Card>
<Card title="Google Workspace" href="/integration-templates/google-workspace" icon="google" iconType="brands">
Sync users from Google Workspace
</Card>
<Card title="Asana" href="/integration-templates/asana" icon="check">
Sync Asana tasks
</Card>
<Card title="GitHub" href="/integration-templates/github" icon="github" iconType="brands">
Sync GitHub issues
</Card>
<Card title="Jira" href="/integration-templates/jira" icon="jira" iconType="brands">
Sync Jira issues
</Card>
</CardGroup>


## Need help with a template?

Please reach out on the [Slack community](https://nango.dev/slack), we are very active there and happy to help!
15 changes: 15 additions & 0 deletions docs-v2/integration-templates/salesforce.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 'Salesforce API Integration Template'
sidebarTitle: 'Salesforce'
---

## Get the template

<Card title="Get it from GitHub"
href="https://github.com/NangoHQ/nango/tree/master/integration-templates/salesforce"
icon="arrow-right">
Get the latest version of the integration template from GitHub
</Card>

## Need help with the template?
Please reach out on the [Slack community](https://nango.dev/slack), we are very active there and happy to help!
15 changes: 15 additions & 0 deletions docs-v2/integration-templates/slack.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 'Slack API Integration Template'
sidebarTitle: 'Slack'
---

## Get the template

<Card title="Get it from GitHub"
href="https://github.com/NangoHQ/nango/tree/master/integration-templates/slack"
icon="arrow-right">
Get the latest version of the integration template from GitHub
</Card>

## Need help with the template?
Please reach out on the [Slack community](https://nango.dev/slack), we are very active there and happy to help!
1 change: 1 addition & 0 deletions docs-v2/integrations/all/asana.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ API configuration: [`asana`](https://nango.dev/providers.yaml)
| [Auth (OAuth)](/guides/oauth) | ✅ |
| [Sync](/guides/sync) | ✅ |
| [Nango Proxy](/guides/proxy) | ✅ |
| [Integration templates](/integration-templates/overview) | ✅ |
| Auto-pagination | 🚫 (time to contribute: &lt;1h) |
| API-specific rate limits | 🚫 (time to contribute: &lt;1h) |

Expand Down
1 change: 1 addition & 0 deletions docs-v2/integrations/all/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ API configuration: [`github`](https://nango.dev/providers.yaml)
| [Auth (OAuth)](/guides/oauth) | ✅ |
| [Sync](/guides/sync) | ✅ |
| [Nango Proxy](/guides/proxy) | ✅ |
| [Integration templates](/integration-templates/overview) | ✅ |
| Auto-pagination | 🚫 (time to contribute: &lt;1h) |
| API-specific rate limits | 🚫 (time to contribute: &lt;1h) |

Expand Down
1 change: 1 addition & 0 deletions docs-v2/integrations/all/google-mail.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ API configuration: [`google-mail`](https://nango.dev/providers.yaml)
| [Auth (OAuth)](/guides/oauth) | ✅ |
| [Sync](/guides/sync) | ✅ |
| [Nango Proxy](/guides/proxy) | ✅ |
| [Integration templates](/integration-templates/overview) | ✅ |
| Auto-pagination | 🚫 (time to contribute: &lt;1h) |
| API-specific rate limits | 🚫 (time to contribute: &lt;1h) |

Expand Down
1 change: 1 addition & 0 deletions docs-v2/integrations/all/google.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ API configuration: [`google`](https://nango.dev/providers.yaml)
| [Auth (OAuth)](/guides/oauth) | ✅ |
| [Sync](/guides/sync) | ✅ |
| [Nango Proxy](/guides/proxy) | ✅ |
| [Integration templates](/integration-templates/overview) | ✅ |
| Auto-pagination | 🚫 (time to contribute: &lt;1h) |
| API-specific rate limits | 🚫 (time to contribute: &lt;1h) |

Expand Down
1 change: 1 addition & 0 deletions docs-v2/integrations/all/jira.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ API configuration: [`jira`](https://nango.dev/providers.yaml)
| [Auth (OAuth)](/guides/oauth) | ✅ |
| [Sync](/guides/sync) | ✅ |
| [Nango Proxy](/guides/proxy) | ✅ |
| [Integration templates](/integration-templates/overview) | ✅ |
| Auto-pagination | 🚫 (time to contribute: &lt;1h) |
| API-specific rate limits | 🚫 (time to contribute: &lt;1h) |

Expand Down
1 change: 1 addition & 0 deletions docs-v2/integrations/all/linear.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ API configuration: [`linear`](https://nango.dev/providers.yaml)
| [Auth (OAuth)](/guides/oauth) | ✅ |
| [Sync](/guides/sync) | ✅ |
| [Nango Proxy](/guides/proxy) | ✅ |
| [Integration templates](/integration-templates/overview) | ✅ |
| Auto-pagination | 🚫 (time to contribute: &lt;1h) |
| API-specific rate limits | 🚫 (time to contribute: &lt;1h) |

Expand Down
1 change: 1 addition & 0 deletions docs-v2/integrations/all/notion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ API configuration: [`notion`](https://nango.dev/providers.yaml)
| [Auth (OAuth)](/guides/oauth) | ✅ |
| [Sync](/guides/sync) | ✅ |
| [Nango Proxy](/guides/proxy) | ✅ |
| [Integration templates](/integration-templates/overview) | ✅ |
| Auto-pagination | 🚫 (time to contribute: &lt;1h) |
| API-specific rate limits | 🚫 (time to contribute: &lt;1h) |

Expand Down
1 change: 1 addition & 0 deletions docs-v2/integrations/all/salesforce.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ API configuration: [`salesforce`](https://nango.dev/providers.yaml)
| [Auth (OAuth)](/guides/oauth) | ✅ |
| [Sync](/guides/sync) | ✅ |
| [Nango Proxy](/guides/proxy) | ✅ |
| [Integration templates](/integration-templates/overview) | ✅ |
| Auto-pagination | 🚫 (time to contribute: &lt;1h) |
| API-specific rate limits | 🚫 (time to contribute: &lt;1h) |

Expand Down
1 change: 1 addition & 0 deletions docs-v2/integrations/all/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ API configuration: [`slack`](https://nango.dev/providers.yaml)
| [Auth (OAuth)](/guides/oauth) | ✅ |
| [Sync](/guides/sync) | ✅ |
| [Nango Proxy](/guides/proxy) | ✅ |
| [Integration templates](/integration-templates/overview) | ✅ |
| Auto-pagination | 🚫 (time to contribute: &lt;1h) |
| API-specific rate limits | 🚫 (time to contribute: &lt;1h) |

Expand Down
3 changes: 2 additions & 1 deletion docs-v2/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The result:

With Nango you build integrations in hours, instead of weeks. You maintain **full control over the integration's logic and access to all of the external APIs**.

Nango combines [production-ready infrastructure](/core-concepts#nango-infrastructure) with pre-built [integration components for 100+ APIs](/integrations/overview):
Nango combines [production-ready infrastructure](/core-concepts#nango-infrastructure) with [pre-built integration components and templates](/integration-templates/overview) for [100+ APIs](/integrations/overview):

- 🔐 Auth for 100+ APIs with 1 line of code
- 🔁 Bi-directional data syncing
Expand Down Expand Up @@ -57,6 +57,7 @@ You can try Nango in 10 minutes with the [Quickstart 🚀](/quickstart).

Or explore more:
- Understand [how Nango works](/core-concepts)
- Explore the [integration templates](/integration-templates/overview)
- Explore the [100+ supported APIs](https://nango.dev/integrations)

## ✅ 100+ pre-configured APIs, easily add your own
Expand Down
26 changes: 25 additions & 1 deletion docs-v2/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,31 @@
"navigation": [
{
"group": "Getting Started",
"pages": ["introduction", "quickstart", "core-concepts"]
"pages": [
"introduction",
"quickstart",
"core-concepts"
]
},
{
"group": "📦 Integration Templates",
"pages": [
"integration-templates/overview",
{
"group": "All Integration Templates",
"pages": [
"integration-templates/asana",
"integration-templates/github",
"integration-templates/google-workspace",
"integration-templates/gmail",
"integration-templates/jira",
"integration-templates/linear",
"integration-templates/notion",
"integration-templates/slack",
"integration-templates/salesforce"
]
}
]
},
{
"group": "Guides",
Expand Down
Loading