https://github.com/pondpilot/pondpilot
A lightweight local first SQL analytics tool. Get your data 🦆 in a row
https://github.com/pondpilot/pondpilot
analytics data duckdb sql wasm
Last synced: 10 months ago
JSON representation
A lightweight local first SQL analytics tool. Get your data 🦆 in a row
- Host: GitHub
- URL: https://github.com/pondpilot/pondpilot
- Owner: pondpilot
- License: agpl-3.0
- Created: 2025-02-26T21:54:21.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-04-01T20:20:27.000Z (10 months ago)
- Last Synced: 2025-04-01T21:29:45.028Z (10 months ago)
- Topics: analytics, data, duckdb, sql, wasm
- Language: TypeScript
- Homepage: https://app.pondpilot.io
- Size: 1.46 MB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# PondPilot - Get your data 🦆 in a row
[](https://www.gnu.org/licenses/agpl-3.0)
PondPilot is a blazing-fast, lightweight, 100% client-side data exploration tool that helps you analyze local & remote data with no setup. Powered by DuckDB-Wasm, it runs entirely in your browser - no install, no servers, no cloud uploads, complete privacy.
## 🔍 Features
- **100% Client-Side**: All processing happens in your browser - no data ever leaves your device
- **PWA Support**: Install PondPilot as a Progressive Web App for offline use
- **No data-copy**: Unlike similar tools, PondPilot doesn't copy files into browser cache, instead accessing them directly. Any changes outside of PondPilot are reflected in real-time
- **Read-only**: PondPilot doesn't write to your files, so you can be sure your data is safe
- **Cross-session persistence**: All data-handles and queries are automatically saved and restored between sessions
- **Powered by DuckDB**: Leverage the powerful SQL engine for fast analysis of large datasets
- **Multiple File Formats**: Support for CSV, Parquet, JSON, DuckDB database and more coming soon
- **Interactive SQL Editor**: Write and execute SQL queries with syntax highlighting and auto-completion
- **Data Visualization**: View, filter, and sort your query results in an interactive table
- **Full-text Schema Explorer**: Easily navigate through tables and columns with auto-generated metadata [coming soon]
- **Data Export**: Export your query results to various formats for further analysis
- **Keyboard Shortcuts**: Navigate efficiently with intuitive keyboard shortcuts
- **Dark/Light Mode**: Choose the interface that's easiest on your eyes
## 🖥️ Demo
## 🚀 Getting Started
### Using the Web App
The easiest way to use PondPilot is through the hosted web app:
1. Visit [https://app.pondpilot.io](https://app.pondpilot.io)
2. Click "Add file" or use keyboard shortcut (Ctrl+F) to load your data
3. Start exploring!
### Browser Requirements
As of today PondPilot only guranteed to work best in Chrome due to the use of File System Access APIs not available in other browsers. Hopefully this will change in the future.
### Running Locally
#### Using Docker
Run PondPilot with a single command:
```bash
docker run -d -p 4173:80 --name pondpilot ghcr.io/pondpilot/pondpilot:latest
```
Visit `http://localhost:4173` in your browser to access the app.
#### Using Yarn
Alternatively, you can build & run PondPilot using Yarn:
```bash
# Clone the repository
git clone https://github.com/pondpilot/pondpilot.git
cd pondpilot
# Setup the project
corepack enable
yarn
# Start the development server
yarn dev
```
Visit `http://localhost:5173` in your browser to access the app.
## ⌨️ Keyboard Shortcuts
- `Ctrl/⌘ + K`: Open spotlight menu to navigate, add files, create new queries and explore shortcuts
- In editor:
- `Ctrl/⌘ + Enter`: Run the entire script
- `Ctrl/⌘ + Shift + Enter`: Run the query under the cursor
- `Ctrl + F`: Add file to analyze
- `Ctrl + D`: Add DuckDB file
- `Ctrl + I`: Import SQL files
## 🚀 Roadmap
The goal for PondPilot is to remain lightweight. We strive to quickly reach feature completeness and then accept only security fixes or updates to keep up with DuckDB.
Here is what we are planning before reaching feature completeness:
* LLM-based code suggestions
* Basic statistics & metadata view without the need to run queries (think data distribution, column types, etc.)
* Additional popular local & remote sources support: XLSX, SQLite, MotherDuck
## 🏷️ Tagged Releases
The official [hosted version](https://app.pondpilot.io/) of PondPilot and the latest tag for our [Docker image](https://ghcr.io/pondpilot/pondpilot) are continuously updated based on the `main` branch. However, we occasionally tag releases to mark significant milestones. You can read the draft release notes for the upcoming tagged version and all released versions on the [release page](https://github.com/pondpilot/pondpilot/releases) or in the [CHANGELOG](CHANGELOG.md).
## 🤝 Contributing
We welcome contributions from the community! Here's how to get started:
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
## 🛠️ Development
### Tech Stack
- React 19 with TypeScript
- Mantine UI components
- Tailwind CSS for styling
- DuckDB-WASM for data processing
- Vite for building
### Available Scripts
- `yarn dev` - Start development server
- `yarn build` - Build production version
- `yarn preview` - Locally preview production build
- `yarn typecheck` - Check TypeScript types
- `yarn lint` - Run ESLint and Stylelint
- `yarn prettier` - Check formatting
- `yarn prettier:write` - Format code
## Similar Projects
DuckDB is awesome, and there are many similar proejcts out there. And there is even more SQL IDE's beyond that. We've been inspired by the following projects:
* [Rill](https://github.com/rilldata/rill)
* [QuackDB](https://github.com/mattf96s/QuackDB)
* [TablePlus](https://tableplus.com)
* [Outerbase Studio](https://github.com/outerbase/studio)
* [harlequin](https://github.com/tconbeer/harlequin)
* [duck-ui](https://github.com/caioricciuti/duck-ui)
And many more!
## 📜 License
PondPilot is licensed under the GNU Affero General Public License v3.0. See the [LICENSE](LICENSE) file for details.
This means you're free to use, modify, and distribute the software, but if you make changes and provide the software as a service over a network, you must make your source code available to users of that service.
## 🙏 Acknowledgments
* Built with [DuckDB-WASM](https://github.com/duckdb/duckdb-wasm) - the powerful SQL database that runs in your browser
* UI components by [Mantine](https://mantine.dev/)
* This project incorporates and modifies code related to query editor from [Outerbase Studio](https://github.com/outerbase/studio) which is licensed under the GNU Affero General Public License v3.0.
---