Skip to content

Commit

Permalink
Merge pull request #581 from panoratech/docs-migration-ef4ccaf
Browse files Browse the repository at this point in the history
docs: Postman collection
  • Loading branch information
rflihxyz authored Jul 29, 2024
2 parents 0ded8e3 + 3f52b03 commit 3070daf
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 87 deletions.
73 changes: 39 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,37 @@
</br>

<p>
<a href="https://panora.dev">Website 🌎</a> - <a href="https://docs.panora.dev">Documentation 📖</a> - <a href="https://status.panora.dev">Status 🟢</a>
<a href="https://panora.dev">Website 🌎</a> - <a href="https://docs.panora.dev">Documentation 📖</a> - <a href="https://discord.com/invite/PH5k7gGubt">Discord 👽</a>
</p>
</div>

### 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

Expand All @@ -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 |
|-----------------------------------------------|:--------:|:-----:|:-----:|:-----------:|:-----:|:-----:|:---------:|
Expand All @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/postman.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: "Postman Collection"
description: ""
---

<Card title="View Collection" href="https://www.postman.com/panoradotdev/workspace/panora/collection/30719650-11871699-943a-4df0-81bf-90d247e44c79" icon={
<img src="logo/postman-icon.svg" />
<Card title="Open Collection" href="https://www.postman.com/panoradotdev/workspace/panora/collection/30719650-11871699-943a-4df0-81bf-90d247e44c79" icon={
<img src="/logo/postman-icon.png" />
} horizontal>
</Card>

2 changes: 1 addition & 1 deletion docs/file-storage/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
<filestorageCatalog />
50 changes: 0 additions & 50 deletions docs/logo/postman-icon.svg

This file was deleted.

0 comments on commit 3070daf

Please sign in to comment.