diff --git a/README.md b/README.md index d08f1c803..2267c69b4 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,50 @@ # **Panora** -![Group 1_updated](https://github.com/panoratech/Panora/assets/39710677/c9a35848-7b48-43af-bd6c-6a5257e19bea) +![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. +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! +# ✨ Join The Pre-Alpha -# ✨ Join The Pre-Alpha We're currently in a private pre-alpha. Click [here](https://form.typeform.com/to/KtthfECD) to get notified when we go public ! # 💻 Deploy Locally - ## Requirements - + +## 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. - ## Run the app +## Run the app + 1. Get the code ``` git clone https://github.com/panoratech/Panora.git ``` + 2. Go to Panora folder ``` cd panora ``` + 3. Start + ``` docker compose --env-file ./.env.example up ``` -You can now open your browser and go to http://localhost to connect to the application. Panora's API is exposed at http://localhost:3000. +You can now open your browser and go to to connect to the application. Panora's API is exposed at . # 🚀 Contributions @@ -50,4 +53,3 @@ 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) -