Skip to content
This repository has been archived by the owner on Mar 10, 2024. It is now read-only.

Commit

Permalink
chore: version 0.7.5 (#611)
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasmarshall authored Apr 11, 2023
1 parent b093ae9 commit 16c5dea
Show file tree
Hide file tree
Showing 125 changed files with 9,803 additions and 24 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ https://user-images.githubusercontent.com/1925713/223279162-c53ceb43-b51e-4d78-9
### Run Supaglue locally

```shell
git clone -b v0.7.4 https://github.com/supaglue-labs/supaglue.git && cd supaglue
git clone -b v0.7.5 https://github.com/supaglue-labs/supaglue.git && cd supaglue
./scripts/create_quickstart_env.sh
docker compose up
```
Expand Down
2 changes: 1 addition & 1 deletion apps/api/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "api",
"version": "0.7.4",
"version": "0.7.5",
"packageManager": "[email protected]",
"type": "commonjs",
"dependencies": {
Expand Down
2 changes: 1 addition & 1 deletion apps/mgmt-ui/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "mgmt-ui",
"version": "0.7.4",
"version": "0.7.5",
"private": true,
"scripts": {
"dev": "next dev",
Expand Down
2 changes: 1 addition & 1 deletion apps/sync-worker/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "sync-worker",
"version": "0.7.4",
"version": "0.7.5",
"packageManager": "[email protected]",
"dependencies": {
"@sentry/integrations": "^7.43.0",
Expand Down
8 changes: 4 additions & 4 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ services:
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-supaglue}

api:
image: supaglue/api:0.7.4
image: supaglue/api:0.7.5
ports:
- '8080:8080'
depends_on:
Expand All @@ -52,7 +52,7 @@ services:
restart: on-failure

sync-worker:
image: supaglue/sync-worker:0.7.4
image: supaglue/sync-worker:0.7.5
depends_on:
postgres:
condition: service_started
Expand All @@ -65,7 +65,7 @@ services:
restart: on-failure

mgmt-ui:
image: supaglue/mgmt-ui:0.7.4
image: supaglue/mgmt-ui:0.7.5
ports:
- '3000:3000'
depends_on:
Expand All @@ -90,7 +90,7 @@ services:
- temporalitedata:/data

init:
image: supaglue/api:0.7.4
image: supaglue/api:0.7.5
environment:
<<: *common-env
SUPAGLUE_QUICKSTART_API_KEY: ${SUPAGLUE_QUICKSTART_API_KEY:-some-api-key}
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ After creating your account, you will be directed to the management portal.
Clone the Github repo and run the Supaglue stack locally using docker compose:

```shell
git clone -b v0.7.4 https://github.com/supaglue-labs/supaglue.git && cd supaglue
git clone -b v0.7.5 https://github.com/supaglue-labs/supaglue.git && cd supaglue
docker compose up
```

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ In less than 5 minutes, sync data from HubSpot or Salesforce into Supaglue and q
Clone our repo, run our setup script which will create an `.env` file for this quickstart, and run the Supaglue stack locally using docker compose:

```shell
git clone -b v0.7.4 https://github.com/supaglue-labs/supaglue.git && cd supaglue
git clone -b v0.7.5 https://github.com/supaglue-labs/supaglue.git && cd supaglue
./scripts/create_quickstart_env.sh
docker compose up
```
Expand Down
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "docs",
"version": "0.7.4",
"version": "0.7.5",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
Expand Down
146 changes: 146 additions & 0 deletions docs/versioned_docs/version-0.7.5/_privacy.md

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions docs/versioned_docs/version-0.7.5/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# API Reference

Supaglue supports 2 APIs:

* [Management API](api/mgmt) can be used to manage customer integrations and connections.
* [CRM API](api/crm) can be used to read and write data that has been synced into Supaglue from third-party CRM providers.
47 changes: 47 additions & 0 deletions docs/versioned_docs/version-0.7.5/architecture.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
sidebar_position: 7
---

# Architecture

import ThemedImage from '@theme/ThemedImage';

<ThemedImage
alt="Architecture Diagram"
width="75%"
sources={{
light: '/img/arch.png',
dark: '/img/arch.png',
}}
/>

## Components

- Sync workflows
- Workflow engine (Temporal)
- DB Cache (Postgres)
- Backend API (Node.js Express)
- Common Model

## Overview

Supaglue is a platform that you can self-host on your infrastructure. It consists of two services, a backend API (Node.js Express) and workflow engine (Temporal), and a database (Postgres).

The backend API serves four purposes:

1. As a management layer for developers to configure Integrations.
2. As an authentication layer for Customers to authenticate with third-party tools to create Connections.
3. As a serving layer for developers to read/write Common Model objects.
4. As a worker layer for Sync workflows to read/write from third-party tools and cache in Supaglue's database.

The database serves as a place to store two types of data:

1. Supaglue application data (Integrations, Connections, Customers).
2. Data from Customers' third-party tools (raw and Common Model formats).

The workflow engine is responsible for scheduling and executing Sync workflows which move data in/out of Supaglue and third-party tools. There are two general kinds of Syncs:

1. Write sync: this sync will create/update records in third-party tools and then update Supaglue's cache.
2. Read sync
- Object sync - this sync is responsible for reading one type of third-party object and saving it to Supaglue's database cache in a raw and Common Model format.
- Association sync - this sync is run after all object syncs, scoped to a Connection, are finished running to associate related objects to one another.
39 changes: 39 additions & 0 deletions docs/versioned_docs/version-0.7.5/concepts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
sidebar_position: 4
---

# Concepts

Learn about major Supaglue concepts.

<dl>
<dt>Common Model</dt>
<dd>A canonical data model that has been standardized across all CRMs.</dd>

<dt>Connector</dt>
<dd>A code package that is used by Supaglue to interact with a CRM's auth, APIs, and object model.</dd>

<dt>Connection</dt>
<dd>A link between a Customer's CRM and a Supaglue Integration.</dd>

<dt>Customer</dt>
<dd>An end-user of a developer's application.</dd>

<dt>Embedded Link</dt>
<dd>A Customer-facing HTTP link that developers embed into their applications so their customers can authenticate their CRMs to the developers' application using Supaglue.</dd>

<dt>Integration</dt>
<dd>An offering made available by a developer to their customers so that Customers can connect their CRMs.</dd>

<dt>Provider</dt>
<dd>A CRM such as Salesforce or HubSpot.</dd>

<dt>Sync workflow</dt>
<dd>A process that Supaglue will run to move data from a third-party tool to/from Supaglue.</dd>

<dt>Sync Info</dt>
<dd>Metadata (start time, end time, status, model name) related to a Sync workflow.</dd>

<dt>Unified API</dt>
<dd>A HTTP API that gives developers a single interface to read and write common data models from multiple CRM providers.</dd>
</dl>
8 changes: 8 additions & 0 deletions docs/versioned_docs/version-0.7.5/connectors/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Connectors",
"position": 5,
"link": {
"type": "doc",
"id": "connectors",
}
}
23 changes: 23 additions & 0 deletions docs/versioned_docs/version-0.7.5/connectors/activecampaign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
sidebar_custom_props:
icon: /img/connector_icons/activecampaign.png
description: ''
---

# Active Campaign

## Overview

Supaglue interfaces with the ActiveCampaign V3 API.


| Feature | Available |
| -------------------------- | --------- |
| Auth | No |
| Reads: Full refresh | No |
| Reads: Incremental refresh | No |
| Creates | No |
| Updates | No |
| Handles rate limits | No |

Supported object types: -
7 changes: 7 additions & 0 deletions docs/versioned_docs/version-0.7.5/connectors/connectors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Connectors

import DocCardList from '@theme/DocCardList';

Here are the CRM connectors built and active maintained by Supaglue Labs. Email us ([email protected]) to request a connector.

<DocCardList />
22 changes: 22 additions & 0 deletions docs/versioned_docs/version-0.7.5/connectors/copper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
sidebar_custom_props:
icon: /img/connector_icons/copper.png
description: ''
---

# Copper

## Overview

Supaglue interfaces with the Copper V1 API.

| Feature | Available |
| -------------------------- | --------- |
| Auth | No |
| Reads: Full refresh | No |
| Reads: Incremental refresh | No |
| Creates | No |
| Updates | No |
| Handles rate limits | No |

Supported object types: -
27 changes: 27 additions & 0 deletions docs/versioned_docs/version-0.7.5/connectors/hubspot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
sidebar_custom_props:
icon: /img/connector_icons/ms_dynamics_365_sales.png
description: ''
---

# HubSpot

## Overview

Supaglue interfaces with the HubSpot V3 API.

| Feature | Available |
| -------------------------- | --------- |
| Auth | Yes |
| Reads: Full refresh | Yes |
| Reads: Incremental refresh | Yes |
| Creates | Yes |
| Updates | Yes |
| Handles rate limits | Yes |

Supported object types:

- Company
- Contact
- Deal
- User
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
sidebar_custom_props:
icon: /img/connector_icons/ms_dynamics_365_sales.png
description: ''
---

# Microsoft Dynamics 365 Sales

## Overview

Supaglue interfaces with the Microsoft Dynamics 365 V9 API.

| Feature | Available |
| -------------------------- | --------- |
| Auth | Yes |
| Reads: Full refresh | No |
| Reads: Incremental refresh | No |
| Creates | No |
| Updates | No |
| Handles rate limits | No |

Supported object types: -

24 changes: 24 additions & 0 deletions docs/versioned_docs/version-0.7.5/connectors/pipedrive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
sidebar_custom_props:
icon: /img/connector_icons/pipedrive.png
description: ''
---

# Pipedrive

## Overview

Supaglue interfaces with the Pipedrive V1 API.

Status: Alpha

| Feature | Available |
| -------------------------- | --------- |
| Auth | Yes |
| Reads: Full refresh | No |
| Reads: Incremental refresh | No |
| Creates | No |
| Updates | No |
| Handles rate limits | No |

Supported object types: -
28 changes: 28 additions & 0 deletions docs/versioned_docs/version-0.7.5/connectors/salesforce.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
sidebar_custom_props:
icon: /img/connector_icons/salesforce.png
description: ''
---

# Salesforce

## Overview

Supaglue uses the Salesforce Bulk 2.0 API and the REST API.

| Feature | Available |
| -------------------------- | --------- |
| Auth | Yes |
| Reads: Full refresh | Yes |
| Reads: Incremental refresh | Yes |
| Creates | Yes |
| Updates | Yes |
| Handles rate limits | Yes |

Supported object types:

- Account
- Contact
- Lead
- Opportunity
- User
22 changes: 22 additions & 0 deletions docs/versioned_docs/version-0.7.5/connectors/zoho_crm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
sidebar_custom_props:
icon: /img/connector_icons/zoho_crm.png
description: ''
---

# Zoho CRM

## Overview

Supaglue interfaces with the Zoho REST V3 API.

| Feature | Available |
| -------------------------- | --------- |
| Auth | Yes |
| Reads: Full refresh | No |
| Reads: Incremental refresh | No |
| Creates | No |
| Updates | No |
| Handles rate limits | No |

Supported object types: -
Loading

1 comment on commit 16c5dea

@vercel
Copy link

@vercel vercel bot commented on 16c5dea Apr 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.