From 45f9b6b6bf5bfc0b787f3a55ee7554a45a03ce1f Mon Sep 17 00:00:00 2001 From: Rachid F <109089247+rflihxyz@users.noreply.github.com> Date: Fri, 8 Dec 2023 17:03:13 +0000 Subject: [PATCH] :memo: Update docs Update Docs --- docs/development.mdx | 70 ++++++++++++++++++++++++++++++++++++++++++++ docs/mint.json | 3 +- 2 files changed, 71 insertions(+), 2 deletions(-) create mode 100644 docs/development.mdx diff --git a/docs/development.mdx b/docs/development.mdx new file mode 100644 index 000000000..b568812b0 --- /dev/null +++ b/docs/development.mdx @@ -0,0 +1,70 @@ +--- +title: 'Development' +description: 'Try Self-hosted Panora and start shipping integrations in less than 5 minutes' + +--- + + + **Prerequisite:** You should have Git and Docker installed + + +Step 1. Open a terminal and download Panora: + +```bash bash +git clone https://github.com/panoratech/Panora.git +``` + +Step 2. Run the following command to enter the folder: + +```bash +cd Panora +``` + +Step 3. Run the following command to start Panora + +```bash +docker compose --env-file ./.env.example up -d +``` + +Step 4. Wait for Panora to download and run + + + Use the following command to check progress. Look at services "Panora-api" and "Panora-webapp" and check in column STATUS both are "UP" + ```bash +docker ps +``` + + +After a few minutes Panora's dashboard will be available at `http://localhost`. +The backend runs on `http://localhost:3000` + +### Congrats, Panora is now ready 🍾πŸ”₯ +### What's next? + +Panora is now ready 🍾πŸ”₯ + +You can invite users to connect with their CRM with a Magic Link (no code needed), or using the API + +## Troubleshooting + +Here's how to solve some common problems when working with the CLI. + + + + Update to Node v18. Run `mintlify install` and try again. + + +Go to the `C:/Users/Username/.mintlify/` directory and remove the `mint` +folder. Then Open the Git Bash in this location and run `git clone +https://github.com/mintlify/mint.git`. + +Repeat step 3. + + + + Try navigating to the root of your device and delete the ~/.mintlify folder. + Then run `mintlify dev` again. + + + +Curious about what changed in a CLI version? [Check out the CLI changelog.](/changelog/command-line) diff --git a/docs/mint.json b/docs/mint.json index 38ab800a4..aacee73ff 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -74,7 +74,6 @@ "footerSocials": { "twitter": "https://twitter.com/panoradotdev", "github": "https://github.com/panoratech/Panora", - "discord": "https://discord.gg/G7fr4HNyTb", - "linkedin": "https://#" + "discord": "https://discord.gg/G7fr4HNyTb" } }