From 3f52b03918c64b2fd5f89e7b24b4e452707af1d7 Mon Sep 17 00:00:00 2001 From: Rachid Flih Date: Mon, 29 Jul 2024 16:18:31 +0100 Subject: [PATCH] docs: Postman collection --- README.md | 73 ++++++++++++++++++---------------- docs/api-reference/postman.mdx | 4 +- docs/file-storage/overview.mdx | 2 +- docs/logo/postman-icon.svg | 50 ----------------------- 4 files changed, 42 insertions(+), 87 deletions(-) delete mode 100644 docs/logo/postman-icon.svg diff --git a/README.md b/README.md index 430dd90cf..7f793964e 100644 --- a/README.md +++ b/README.md @@ -15,18 +15,37 @@

- Website 🌎 - Documentation πŸ“– - Status 🟒 + Website 🌎 - Documentation πŸ“– - Discord πŸ‘½

-### Have you met anyone who loves developing integrations? *No.* That’s why we designed an easy developer experience that you’ll enjoy -- **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 +# πŸ•ΉοΈ Try -### More than a devtool: Panora helps you put your product at the core of your customer's daily workflows +- Prerequisite: You should have Git and Docker installed + + 1. Get the code + +``` + git clone https://github.com/panoratech/Panora.git + ``` + + 2. Go to Panora folder + +``` + cd Panora && cp .env.example .env + ``` + + 3. Start + +``` + docker compose up + ``` + +Panora is now running! Follow our [Quickstart Guide](https://docs.panora.dev/quick-start) to start adding integrations to your product ! + +See also [our selfhost guide here !](https://docs.panora.dev/open-source/selfhost/self-host-guide) -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. # ✨ Core Features @@ -43,7 +62,7 @@ Panora supports integration with the following objects across multiple platforms [Here is an extensive list of all integrations !](https://docs.panora.dev/integrations-catalog) -### CRM +### CRM Unified API | | Contacts | Deals | Notes | Engagements | Tasks | Users | Companies | |-----------------------------------------------|:--------:|:-----:|:-----:|:-----------:|:-----:|:-----:|:---------:| @@ -53,48 +72,34 @@ Panora supports integration with the following objects across multiple platforms | Zendesk Sell | βœ”οΈ | βœ”οΈ | βœ”οΈ | βœ”οΈ | βœ”οΈ | βœ”οΈ | | | Attio | βœ”οΈ | | | | | | βœ”οΈ | -### Ticketing +### Ticketing Unified API -| | Tickets | Comments | Users | Contacts | Accounts | Tags | Teams | Collections | +| | Tickets | Comments | Users | Contacts | Accounts | Tags | Teams | Collections | |-------------|:----------:|:-------:|:-------:|:------------:|:-------:|:-------:|:------:|:-------------:| | Zendesk | βœ” | βœ” | βœ” | βœ” | βœ” | βœ” | βœ” | | | Front | βœ” | βœ” | βœ” | βœ” | βœ” | βœ” | βœ” | | | Jira | βœ” | βœ” | βœ” | | | βœ” | βœ” | βœ” | -| Gorgias | βœ” | βœ” | βœ” | βœ” | | βœ” | βœ” | | - -### ATS (New!) +| Gitlab | βœ” | βœ” | βœ” | | | | | βœ”| + +### ATS Unified API (New!) | | Activities | Applications | Candidates | Departments | Interviews | Jobs | Offers | Offices | Scorecard | Users | |-------------|:----------:|:------------:|:----------:|:-----------:|:----------:|:----:|:------:|:-------:|:---------:|:-----:| | Ashby | βœ” | βœ” | βœ” | βœ” | βœ” | βœ” | βœ” | βœ” | βœ” | βœ” | -Your favourite software is missing? [Ask the community to build a connector!](https://github.com/panoratech/Panora/issues/new) - -# πŸ•ΉοΈ Try the Open-Source version - -- Prerequisite: You should have Git and Docker installed - - 1. Get the code - -``` - git clone https://github.com/panoratech/Panora.git - ``` - - 2. Go to Panora folder -``` - cd Panora && cp .env.example .env - ``` +### File Storage Unified API - 3. Start +| File Storage | Drives | Files | Folders | Groups | Users | Permissions | Shared Links | +|-----------------------------------------------|:--------:|:-----:|:-----:|:-----------:|:-----:|:-----:|:---------:| +| [Google Drive]() | βœ”οΈ | βœ”οΈ | βœ”οΈ | βœ”οΈ | βœ”οΈ | | | +| [Box]() | | βœ”οΈ | βœ”οΈ | βœ”οΈ | βœ”οΈ | βœ”οΈ | | +| [Dropbox]() | | βœ”οΈ | βœ”οΈ | βœ”οΈ | βœ”οΈ | βœ”οΈ | | +| [OneDrive]() | βœ”οΈ | βœ”οΈ | βœ”οΈ| βœ”οΈ | βœ”οΈ | | | -``` - docker compose up - ``` -Visit our [Quickstart Guide](https://docs.panora.dev/quick-start) to start adding integrations to your product ! -See also [our selfhost guide here !](https://docs.panora.dev/open-source/selfhost/self-host-guide) +Your favourite software is missing? [Ask the community to build a connector!](https://github.com/panoratech/Panora/issues/new) # πŸ‘Ύ Join the community diff --git a/docs/api-reference/postman.mdx b/docs/api-reference/postman.mdx index 7a6d6eeae..97fc36dfa 100644 --- a/docs/api-reference/postman.mdx +++ b/docs/api-reference/postman.mdx @@ -3,8 +3,8 @@ title: "Postman Collection" description: "" --- - + } horizontal> diff --git a/docs/file-storage/overview.mdx b/docs/file-storage/overview.mdx index 05d9ee98c..14ba8e49f 100644 --- a/docs/file-storage/overview.mdx +++ b/docs/file-storage/overview.mdx @@ -4,7 +4,7 @@ description: '' --- import filestorageCatalog from '/snippets/filestorage-catalog.mdx'; -Welcome to the reference documentation for the Panora File Storage (CRM) API! This API allows you to integrate with Panora and read data from or write data into the integrations authorized by your users. +Welcome to the reference documentation for the Panora File Storage API! This API allows you to integrate with Panora and read data from or write data into the integrations authorized by your users. ## Supported File Storage Providers & Objects \ No newline at end of file diff --git a/docs/logo/postman-icon.svg b/docs/logo/postman-icon.svg deleted file mode 100644 index 87ed4ac39..000000000 --- a/docs/logo/postman-icon.svg +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file