diff --git a/README.md b/README.md index 078770082..c95a84fb9 100644 --- a/README.md +++ b/README.md @@ -1,89 +1,93 @@ -# **Panora** +
+ +

🌼 Welcome on Panora

+ +

Panora puts your customer facing integration on autopilot

+

Ship dozens of integrations without losing sleep

+ +
+ Discord + GitHub Repo stars + GitHub License + X (formerly Twitter) Follow + Known Vulnerabilities +
+ +

+ Website 🌎 - Documentation 📖 - Status 🟢 +

-![Group 1_updated](https://github.com/panoratech/Panora/assets/39710677/c9a35848-7b48-43af-bd6c-6a5257e19bea) - -
- Known Vulnerabilities
-Our product makes it quick and easy for SaaS teams to ship customer-facing integrations between their product and others. -We do so by providing a single API that abstracts similar tools your customer may use along your product behind a common data model. +
-This way, you can write one code to push data anywhere! -# 💻 Try Self-hosted +
-## Requirements - 1. Install Docker on your machine. - 2. Make sure Docker Compose is installed and available (it should be the case if you have chosen to install Docker via Docker Desktop). - 3. Make sure Git is installed on your machine. +![Group 1_updated](https://github.com/panoratech/Panora/assets/39710677/c9a35848-7b48-43af-bd6c-6a5257e19bea) -## Run the app +### Have you met anyone who loves developing integrations? *No.* That’s why we designed an easy developer experience that you’ll enjoy. - 1. Get the code +- **Simple developer experience:** easy to self-host, uses industry-standard data models, and is extensible +- **Builder-friendly terms:** Panora is open-source, and offers generous tips for contributors -``` - git clone https://github.com/panoratech/Panora.git - ``` +### More than a devtool: Panora helps you put your product at the core of your customer's daily workflows - 2. Go to Panora folder +Your customers expect all of their tools to work well together. Panora avoids your team spending hundreds of hours building and maintaining integrations instead of your core product. -``` - cd panora - ``` - 3. Start +## 🔮 Core Features -``` - docker compose --env-file ./.env.example up - ``` +| | +|---------------------------| +| **Magic Links:** Let your users grant you access to their data. Without writing code. | +| **Custom Fields:** Reflect in Panora the specific data points that matter to your users | +| **Passthrough Requests:** Interact with other software platforms in their native format. | +| **Flexible Sync Settings:** Businesses that need real-time update can configure Panora accordingly | +| **Webhooks:** Listen to one webhook to receive normalized data from various software platforms | -You can now open your browser and go to to connect to the application. Panora's API is exposed at . -Read more on our [quickstart guide](https://docs.panora.dev/quickstart) -Capture d’écran 2023-12-09 à 01 43 02 +## 🤝 Core Values +| | +|-------------------------------------------| +| 💻 Easy Developer Experience | +| 🫡 Fair Value Share: Contributors are valuable, so we've decided to let our community tip our heroes | -# ✨ Join The cloud Pre-Alpha +## 🕹️ Play with the Self-hosted version -We're launching our clourd version soon. Click [here](https://form.typeform.com/to/KtthfECD) to get notified when we go public! +- Prerequisite: You should have Git and Docker installed -# 🚀 Roadmap -CRMs: + 1. Get the code -- [x] Hubspot -- [x] Zoho CRM -- [x] Pipedrive -- [x] Salesforce -- [x] Zendesk -- [ ] Other CRMs such as Freshsales, MS 365... +``` + git clone https://github.com/panoratech/Panora.git + ``` -Ticketing: + 2. Go to Panora folder -- [ ] Slack -- [ ] Discord -- [ ] Jira -- [ ] Asana -- [ ] Microsoft Teams +``` + cd panora + ``` -Accounting: + 3. Start -- [ ] Sage -- [ ] Freshbooks -- [ ] Clearbooks -- [ ] FreeAgent +``` + docker compose --env-file ./.env.example up + ``` -...and more +You can now open your browser and go to to connect to the application. +Visit our [Quickstart Guide](https://docs.panora.dev/quick-start) to start adding integrations to your product +## 🤔 Have questions? Ask the core team +Book us with Cal.com -# 🚀 Contributions +## 🚀 Contributions This guide is intended for people willing to contribute to Panora. - You can follow this guide to set up a Panora development environment on your machine. - You can contribute by following our [guidelines.](https://github.com/panoratech/Panora/blob/main/CONTRIBUTING.md) diff --git a/docs/mint.json b/docs/mint.json index 144c54a74..5b2fdd67b 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -11,7 +11,7 @@ }, "raiseIssue": true, "api": { - "baseUrl": "https://api-dev.panora.dev", + "baseUrl": "https://api-demo.panora.dev", "auth": { "method": "key" } diff --git a/docs/webhooks/event-types.mdx b/docs/webhooks/event-types.mdx index 10adcf199..1a9b82428 100644 --- a/docs/webhooks/event-types.mdx +++ b/docs/webhooks/event-types.mdx @@ -3,18 +3,13 @@ title: 'Event Types' description: '.' icon: 'wand-magic-sparkles' --- - -Types of events This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist. You’ll notice that these events follow a pattern: resource.event. Our goal is to design a consistent system that makes things easier to anticipate and code against. Events that occur on subresources like customer.subscription do not trigger the parent’s update event. -Events marked as Selection required are only created when a webhook has been configured to listen for that type of event specifically. A webhook set to listen to all events will not receive an event requiring explicit selection. - - | Events | |--------------------------------------------------------------------------------------| -| `crm.contact.created`

Occurs whenever a new contact was created in a CRM. Sent only if the contact wasn't created using Panora. The `data` field is a `CRM` `Contact` object| -| `crm.contact.updated`

Occurs whenever a new contact was updated in a CRM. Sent only if the contact wasn't created using Panora. The `data` field is a `CRM` `Contact` object | -| `crm.contact.deleted`

Occurs whenever a new contact was deleted in a CRM. Sent only if the contact wasn't created using Panora. The `data` field is a `CRM` `Contact` object | -| `magic_link.connected`

Occurs when a new connection was created through a Magic Link. | +| **crm.contact.created**

Occurs whenever a new contactclear was created in a CRM. The `data` field is a `CRM` `Contact` object| +| **crm.contact.updated**

Occurs whenever a new contact was updated in a CRM. The `data` field is a `CRM` `Contact` object | +| **crm.contact.deleted**

Occurs whenever a new contact was deleted in a CRM. The `data` field is a `CRM` `Contact` object | +| **magic_link.connected**

Occurs when a new connection was created through a Magic Link. | \ No newline at end of file diff --git a/docs/welcome.mdx b/docs/welcome.mdx index a404e7dc0..198c8ae49 100644 --- a/docs/welcome.mdx +++ b/docs/welcome.mdx @@ -64,4 +64,6 @@ Your customers expect all of their tools to work well together. Panora avoids yo -[✏️ Suggest an update](https://tally.so/r/mRD1QQ?feedback_source=welcome) \ No newline at end of file +[✏️ Suggest an update](https://tally.so/r/mRD1QQ?feedback_source=welcome) + +