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โ€™eฬcran 2023-12-09 aฬ€ 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)