Skip to content

Commit

Permalink
📝 Update docs
Browse files Browse the repository at this point in the history
Update Docs
  • Loading branch information
rflihxyz committed Dec 8, 2023
1 parent c28e7a8 commit 45f9b6b
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 2 deletions.
70 changes: 70 additions & 0 deletions docs/development.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: 'Development'
description: 'Try Self-hosted Panora and start shipping integrations in less than 5 minutes'

---

<Info>
**Prerequisite:** You should have Git and Docker installed
</Info>

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

<Tip>
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
```

</Tip>
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.

<AccordionGroup>
<Accordion title="Mintlify is not loading">
Update to Node v18. Run `mintlify install` and try again.
</Accordion>
<Accordion title="No such file or directory on Windows">
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.

</Accordion>
<Accordion title="Getting an unknown error">
Try navigating to the root of your device and delete the ~/.mintlify folder.
Then run `mintlify dev` again.
</Accordion>
</AccordionGroup>

Curious about what changed in a CLI version? [Check out the CLI changelog.](/changelog/command-line)
3 changes: 1 addition & 2 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}

0 comments on commit 45f9b6b

Please sign in to comment.