Skip to content

Updated potpie-ui readme #330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kshitij2040 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Updated potpie-ui readme #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed1b77f
update: submodule changes - README and assets
kshitij2040 Feb 19, 2026
9a040d6
docs: update UI readme - correct agent list and visual improvements
kshitij2040 Feb 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
163 changes: 95 additions & 68 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,130 +1,157 @@
<p align="center">
<a href="https://potpie.ai?utm_source=github">
<img src="https://github.com/user-attachments/assets/1a0b9824-833b-4c0a-b56d-ede5623295ca" width="318px" alt="Potpie logo" />
<picture>
<source media="(prefers-color-scheme: dark)" srcset="../assets/readme_logo_dark.svg" />
<source media="(prefers-color-scheme: light)" srcset="../assets/logo_light.svg" />
<img src="../assets/logo_light.svg" alt="Potpie AI logo" />
</picture>
Comment on lines +3 to +7

@coderabbitai coderabbitai Bot Feb 22, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check where the assets directory is located
echo "=== Looking for assets directory ==="
fd -t d "assets"

echo -e "\n=== Checking all image references in markdown files ==="
rg -n "assets/" --glob "*.md" -C 1

echo -e "\n=== Checking all srcset and src attributes ==="
rg -n "(srcset|src)=" --glob "*.md" -C 1

echo -e "\n=== Full directory structure at repo root ==="
ls -la

Repository: potpie-ai/potpie-ui

Length of output: 4256

🏁 Script executed:

#!/bin/bash
# Verify the assets directory contains the referenced files
echo "=== Contents of assets directory ==="
ls -la assets/

echo -e "\n=== Confirm file existence ==="
test -f "assets/readme_logo_dark.svg" && echo "✓ readme_logo_dark.svg exists" || echo "✗ readme_logo_dark.svg missing"
test -f "assets/logo_light.svg" && echo "✓ logo_light.svg exists" || echo "✗ logo_light.svg missing"
test -f "assets/dashboard.gif" && echo "✓ dashboard.gif exists" || echo "✗ dashboard.gif missing"

Repository: potpie-ai/potpie-ui

Length of output: 396

Critical: Image files referenced in README are missing and paths are broken.

All image references use ../assets/… paths, which resolve outside the repository root on GitHub, breaking image display. Additionally, the referenced image files do not exist in the assets/ directory:

  • readme_logo_dark.svg — missing
  • logo_light.svg — missing
  • dashboard.gif — missing

The assets/ directory exists at the repository root but contains only home_page.png.

Either add the three missing image files to the assets/ directory and correct the paths to ./assets/… (or assets/…), or replace the image references with external URLs.

Affected lines: 4–6 (logo), 16 (dashboard)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 3 - 7, The README's picture block references missing
files and uses paths that resolve outside the repo root; place the three missing
images (readme_logo_dark.svg, logo_light.svg, dashboard.gif) into the repository
root assets folder and update the <source> srcset and <img> src attributes in
the README's picture element (and any dashboard GIF reference) to use relative
in-repo paths like ./assets/readme_logo_dark.svg and ./assets/logo_light.svg (or
absolute assets/logo_light.svg), or alternatively replace those src/srcset
values with stable external URLs pointing to the images.

</a>
</p>

<h1 align="center">Prompt-To-Agent: Create custom engineering agents for your code</h1>

<p align="center">
<strong>User Interface</strong>
</p>

<p align="center">
<a href="https://github.com/potpie-ai/potpie/stargazers">
<img src="https://img.shields.io/github/stars/potpie-ai/potpie-ui" alt="Stars" />
</a>
<a href="https://twitter.com/potpiedotai">
<img src="https://img.shields.io/twitter/follow/potpiedotai?style=social" alt="Twitter" />
</a>
<br/>
<a href="https://discord.gg/ryk5CMD5v6">
<img src="https://img.shields.io/badge/Join%20our-Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Join our Discord">
</a>
## Potpie


<p align="center">
<img width="700" alt="Potpie Dashboard" src="../assets/dashboard.gif" />
</p>

<p align="center">
<img width="1506" alt="Potpie UI Screenshot" src="https://github.com/user-attachments/assets/a400b48f-dc4c-47b1-a42b-26eaf062adb2" />
<a href="https://docs.potpie.ai"><img src="https://img.shields.io/badge/Docs-Read-blue?logo=readthedocs&logoColor=white" alt="Docs"></a>
<a href="https://github.com/potpie-ai/potpie/blob/main/LICENSE"><img src="https://img.shields.io/github/license/potpie-ai/potpie" alt="Apache 2.0"></a>
<a href="https://github.com/potpie-ai/potpie"><img src="https://img.shields.io/github/stars/potpie-ai/potpie" alt="GitHub Stars"></a>
Comment on lines +21 to +22

@coderabbitai coderabbitai Bot Feb 22, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check for a LICENSE file in the repo root
fd -t f "LICENSE" --max-depth 1

Repository: potpie-ai/potpie-ui

Length of output: 70

🏁 Script executed:

# Also check the README to see the current state at lines 21-22
head -30 README.md | cat -n

Repository: potpie-ai/potpie-ui

Length of output: 1398

License and Stars badges reference the wrong repository.

Both the license badge (line 21) and stars badge (line 22) point to potpie-ai/potpie (the main backend repo) rather than potpie-ai/potpie-ui (this repo). A LICENSE file exists in this repository, so the badges should reference potpie-ai/potpie-ui for consistency.

Proposed fix 
-  <a href="https://github.com/potpie-ai/potpie/blob/main/LICENSE"><img src="https://img.shields.io/github/license/potpie-ai/potpie" alt="Apache 2.0"></a>
-  <a href="https://github.com/potpie-ai/potpie"><img src="https://img.shields.io/github/stars/potpie-ai/potpie" alt="GitHub Stars"></a>
+  <a href="https://github.com/potpie-ai/potpie-ui/blob/main/LICENSE"><img src="https://img.shields.io/github/license/potpie-ai/potpie-ui" alt="Apache 2.0"></a>
+  <a href="https://github.com/potpie-ai/potpie-ui"><img src="https://img.shields.io/github/stars/potpie-ai/potpie-ui" alt="GitHub Stars"></a>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<a href="https://github.com/potpie-ai/potpie/blob/main/LICENSE"><img src="https://img.shields.io/github/license/potpie-ai/potpie" alt="Apache 2.0"></a>
<a href="https://github.com/potpie-ai/potpie"><img src="https://img.shields.io/github/stars/potpie-ai/potpie" alt="GitHub Stars"></a>
<a href="https://github.com/potpie-ai/potpie-ui/blob/main/LICENSE"><img src="https://img.shields.io/github/license/potpie-ai/potpie-ui" alt="Apache 2.0"></a>
<a href="https://github.com/potpie-ai/potpie-ui"><img src="https://img.shields.io/github/stars/potpie-ai/potpie-ui" alt="GitHub Stars"></a>
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 21 - 22, Update the two GitHub badge links in
README.md that currently point to potpie-ai/potpie: locate the anchor elements
containing the license badge (the <a
...href="https://github.com/potpie-ai/potpie/blob/main/LICENSE">... badge) and
the stars badge (the <a ...href="https://github.com/potpie-ai/potpie">... badge)
and change their hrefs to reference potpie-ai/potpie-ui (and the LICENSE path to
potpie-ai/potpie-ui/blob/main/LICENSE) so both badges point to this repository.

<a href="https://discord.gg/ryk5CMD5v6"><img src="https://img.shields.io/badge/Discord-Join-5865F2?logo=discord&logoColor=white" alt="Discord"></a>
</p>

## 📋 Table of Contents
---

- [Overview](#-overview)
- [Features](#-features)
- [Quick Start](#-quick-start)
- [Development](#-development)
## Table of Contents

- [Overview](#overview)
- [Features](#features)
- [Quick Start](#quick-start)
- [Development](#development)
- [Local Development Mode](#local-development-mode)
- [Production Mode](#production-mode)
- [Contributing](#-contributing)
- [License](#-license)
- [Contributing](#contributing)
- [License](#license)

## 🚀 Overview
---

Potpie is an open-source platform that creates AI agents specialized in your codebase, enabling automated code analysis, testing, and development tasks. By building a comprehensive knowledge graph of your code, Potpie's agents can understand complex relationships and assist with everything from debugging to feature development.
## Overview

This repository contains the User Interface for the Potpie platform.
Potpie turns your entire codebase into a **knowledge graph** - a structural index of every file, class, and function, capturing all their relationships and what each part of the code does in context of everything else. AI agents built on this graph can reason about your code with the precision of someone who wrote it.

## ✨ Features
This repository contains the **User Interface** for the Potpie platform.

- **Custom AI Agents**: Create agents tailored to your specific codebase from a single prompt
- **Pre-Built Agents**: Choose from available list of Q&A, Debugging, Unit Test, Integration Test, Low Level Design, Code Generation Agents
- **Chat**: Easy to use chat interface to interact with your agents with streaming support.
---

## 🏁 Quick Start
## Features

1. Clone the repository:
```bash
git clone https://github.com/potpie-ai/potpie-ui.git
cd potpie-ui
```
<table>
<tr>
<td valign="top" width="33%">
<h3>Custom AI Agents</h3>
<p>Create agents tailored to your specific codebase from a single prompt.</p>
</td>
<td valign="top" width="33%">
<h3>Pre-Built Agents</h3>
<p>Choose from Debugging, Codebase Q&amp;A, Code Generation, and Code Changes agents.</p>
</td>
<td valign="top" width="33%">
<h3>Chat Interface</h3>
<p>Easy-to-use chat with streaming support — interact with your agents in real time.</p>
</td>
</tr>
</table>

2. Copy the required configurations:
```bash
cp .env.template .env
```
---

3. Install dependencies and run the development server:
```bash
pnpm install
pnpm build
pnpm run dev
```
## Quick Start

```bash
# 1. Clone the repository
git clone https://github.com/potpie-ai/potpie-ui.git
cd potpie-ui

# 2. Copy environment config
cp .env.template .env

# 3. Install dependencies and start
pnpm install
pnpm build
pnpm run dev
```
Comment on lines +72 to +84

@coderabbitai coderabbitai Bot Feb 22, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Remove the redundant pnpm build step from the Quick Start.

pnpm build runs a full production build, which is unnecessary before pnpm run dev. This will confuse new contributors and double their onboarding time. The pnpm build + pnpm start sequence already appears correctly in the Production Mode section.

🐛 Proposed fix 
 # 3. Install dependencies and start
 pnpm install
-pnpm build
 pnpm run dev
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
```bash
# 1. Clone the repository
git clone https://github.com/potpie-ai/potpie-ui.git
cd potpie-ui
# 2. Copy environment config
cp .env.template .env
# 3. Install dependencies and start
pnpm install
pnpm build
pnpm run dev
```
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 72 - 84, Remove the redundant pnpm build step from
the Quick Start command block: in the section that currently lists "pnpm
install", "pnpm build", "pnpm run dev", delete the "pnpm build" line so the
sequence becomes "pnpm install" then "pnpm run dev"; ensure the surrounding text
and step numbering (if present) remain correct and that the Production Mode
section still retains the existing "pnpm build" + "pnpm start" sequence.


Open [http://localhost:3000](http://localhost:3000) in your browser.

4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
---

## 💻 Development
## Development

### Local Development Mode

This project supports a local development mode that allows you to run the app without external service dependencies. The app automatically detects if configuration for these services is missing and falls back to mock implementations:
This project supports a local development mode — the app automatically detects missing configurations and falls back to mock implementations:

- **Firebase Authentication**: Uses a mock user with predetermined credentials
- **PostHog Analytics**: Uses a no-op implementation
- **Formbricks Bug Reporting**: Disabled in local mode
| Service | Local Mode Behaviour |
|---|---|
| **Firebase Authentication** | Mock user with preset credentials (`local-dev@example.com`) |
| **PostHog Analytics** | No-op implementation — no data sent |
| **Formbricks Bug Reporting** | Disabled |

#### How to Use Local Development Mode

1. Create a `.env` file without the following environment variables:
1. Create a `.env` file **without** the following variables:
- Firebase: `NEXT_PUBLIC_FIREBASE_API_KEY`, `NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN`, etc.
- PostHog: `NEXT_PUBLIC_POSTHOG_KEY`, `NEXT_PUBLIC_POSTHOG_HOST`
- Formbricks: `NEXT_PUBLIC_FORMBRICKS_ENVIRONMENT_ID`, `NEXT_PUBLIC_FORMBRICKS_API_HOST`

2. Run the application normally with:
2. Run normally — the app detects missing config and uses mocks:
```bash
pnpm run dev
```

3. The app will automatically detect missing configurations and use mock implementations.

4. You'll be automatically logged in with a mock user (uid: 'local-dev-user', email: 'local-dev@example.com')
3. You'll be automatically logged in as:
- uid: `local-dev-user`
- email: `local-dev@example.com`

### Production Mode

For production deployment, you'll need to set up the following services:
For production, configure the following services:

1. **Firebase Authentication**: Set up Firebase credentials for authentication
2. **PostHog Analytics**: Configure PostHog for analytics tracking (optional)
3. **Formbricks**: Set up for bug reporting (optional)
| Service | Purpose | Required |
|---|---|---|
| **Firebase Authentication** | User auth | ✅ Yes |
| **PostHog Analytics** | Usage tracking | Optional |
| **Formbricks** | Bug reporting | Optional |

Configure your environment variables in `.env` file and run:
Set your values in `.env` and run:

```bash
pnpm run build
pnpm start
```

## 👥 Contributing
---

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.
Contributions are welcome! Please read the [Contributing Guide](https://github.com/potpie-ai/potpie/blob/main/.github/CONTRIBUTING.md) before submitting a PR.

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## 📄 License
<p>
<a href="https://github.com/potpie-ai/potpie/blob/main/.github/CONTRIBUTING.md">
<img src="https://img.shields.io/badge/Read-Contributing%20Guide-22c55e?style=for-the-badge" alt="Contributing Guide"/>
</a>
</p>

---

## License

This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.
This project is licensed under the Apache 2.0 License — see the [LICENSE](LICENSE) file for details.
Binary file added assets/home_page.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading