-
Notifications
You must be signed in to change notification settings - Fork 195
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
🐛 Fix project connectors inside code #486
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,10 +25,10 @@ We made a docker file that builds Panora from sources, specifically to help you | |
</Info> | ||
You have the option to manage a custom 3rd party OAuth App. | ||
|
||
**Each custom 3rd party environment variable must be of the form `PROVIDER_VERTICAL_SOFTWAREMODE_ATTRIBUTE` where** | ||
**Each custom 3rd party environment variable must be of the form `PROVIDER_category_SOFTWAREMODE_ATTRIBUTE` where** | ||
|
||
- `PROVIDER` is any 3rd party name | ||
- `VERTICAL` is for example [CRM, TICKETING, MARKETINGAUTOMATION, ...] | ||
- `category` is for example [CRM, TICKETING, MARKETINGAUTOMATION, ...] | ||
- `SOFTWAREMODE` is [ CLOUD, ONPREMISE ] | ||
- `ATTRIBUTE` is for example [ CLIENT_ID, CLIENT_SECRET, SUBDOMAIN, ... ] | ||
|
||
|
@@ -64,7 +64,7 @@ Make sure you are inside `packages/api/src` where the server lives ! | |
|
||
_Ie: Slack, Hubspot, Jira, Shopify ..._ | ||
|
||
First choose wisely which vertical the 3rd party belongs to among these: | ||
First choose wisely which category the 3rd party belongs to among these: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add a comma for clarity. - Ie: Slack, Hubspot, Jira, Shopify ...
+ Ie: Slack, Hubspot, Jira, Shopify, ... This minor punctuation addition improves the readability of the list.
|
||
|
||
- `crm` | ||
- `ticketing` | ||
|
@@ -74,14 +74,16 @@ First choose wisely which vertical the 3rd party belongs to among these: | |
- `hris` | ||
- `marketingautomation` | ||
|
||
You can find all categories inside [`packages/shared/src/categories.ts`](https://github.com/panoratech/Panora/blob/main/packages/shared/src/categories.ts). | ||
|
||
<Info> | ||
For the sake of the guide, now on we'll consider adding a 3rd party belonging | ||
to the `crm` vertical. | ||
to the `crm` category. | ||
</Info> | ||
|
||
# Step 1: Ensure 3rd party metadata is set | ||
|
||
Look into the `packages/shared/src/utils.ts` file and check if the provider you want to build has its metadata set inside the `CONNECTORS_METADATA` object. | ||
Look into the `packages/shared/src/connectors/metadata.ts` file and check if the provider you want to build has its metadata set inside the `CONNECTORS_METADATA` object. | ||
|
||
It should be available (if not [contact us](https://app.cal.com/rflih/30)) with `active` field set to `false` meaning the integration has not been built. | ||
|
||
|
@@ -96,7 +98,7 @@ Actually an integration is built in 2 parts : | |
|
||
_Ie: Contact, Ticket, Deal, Company ..._ | ||
|
||
For the sake of this guide, let's map the common object `contact` under `crm` vertical to _my3rdParty_ (in reality it would be a real 3rd party name). | ||
For the sake of this guide, let's map the common object `contact` under `crm` category to _my3rdParty_ (in reality it would be a real 3rd party name). | ||
|
||
<Info> | ||
**An integration is considered valid when all common objects have been mapped. | ||
|
@@ -229,7 +231,7 @@ For the sake of this guide, let's map the common object `contact` under `crm` ve | |
We built a script that does it in seconds. You can execute the given command from the root directory of Panora. | ||
|
||
```bash | ||
cd packages/api && pnpm install && pnpm run validate-connectors --vertical="crm" --objectType="contact" | ||
cd packages/api && pnpm install && pnpm run validate-connectors --category="crm" --objectType="contact" | ||
``` | ||
|
||
The script will automatically scan the `/crm/contact/services` folder and detect any new service folder so all dependencies and imports are updated across the codebase. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Clarify the environment variable format.
The explanation of the environment variable format is clear, but it might be helpful to provide a brief description or link to documentation on what each component (
PROVIDER
,category
,SOFTWAREMODE
,ATTRIBUTE
) represents. This could improve understanding for new contributors.