Skip to content

Latest commit

 

History

History
129 lines (83 loc) · 5.36 KB

README.md

File metadata and controls

129 lines (83 loc) · 5.36 KB
Raw

🥨 Pretzel

License GitHub Stars

Live deployed build: https://pretzelai.github.io

Pretzel is an open-source, offline browser-based tool for fast and intuitive data exploration and visualization. It can handle large data files, runs locally in your browser, and requires no backend setup. Pretzel makes it easy to manipulate data via visual chained data transform blocks. It's also reactive - chaging an tranform block in the chain automatically updates all transform blocks and charts that follow.

demo.gif

Features

  • 🚀 Blazing-fast performance with WebAssembly-based DuckDB and PRQL
  • 🔍 Intuitive data exploration with a visual, top-down pipeline of data transformations and visualizations
  • 🧠 AI-powered transformation block to help with fast data manipulation
  • 🔒 Privacy-first design: run Pretzel AI locally or host it yourself for full control over your data
  • 📊 Upcoming features: Local LLM support, API calls, in-browser Python support with Pyodide, save and share workflows securely and canvas based table rendering

Table of Contents

Demo video

Pretzel.mp4

Getting Started

Website (Easiest)

The easiest way to use Pretzel is to visit https://pretzelai.github.io

Offline standalone app

Since Pretzel doesn't have a backend you can easily install it as a Chrome app and it will work even without internet (for those long flights!)

  1. Visit https://pretzelai.github.io in Chrome

  2. Click the install app icon

pretzel_chrome_install
  1. Now you can launch Pretzel as a standalone app. It will also work offline, it may error if you try to use some internet feature (like the AI Block), just close it and open it again to fix it
pretzel_app_icon

Developers

Run locally

To run Pretzel locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/pretzelai/pretzelai.git

  2. Install dependencies:

    cd pretzelai
npm install

  3. Start the development server:

    npm run start

  4. Open your browser and navigate to http://localhost:3000

Host Pretzel

To host Pretzel, follow these steps (it's just a static website!):

  1. Build the app
npm run build
  1. Upload the contents of the dist folder to your hosting. This is what you can find live at https://pretzelai.github.io

Deploy to Render

Optional configuration

  • Bug report box: Update /src/lib/config.ts with your PostHog config to let users report bugs directly on the website
  • AI Endpoint: Deploy a cloud function to provide an AI endpoint for users without an OpenAI API key. Check the cloud folder for instructions.

Implemented transformation blocks

  • Upload: accepts CSV / Excel (XLSX) files
  • Filter: string/number/date filtering including nested filters
  • Ask AI: connects to OpenAI to transform user command to SQL
  • Pivot: to create a pivot table (you can also go group-by using this - only use the Rows and Values fields)
  • Sort: sorts ascending or descending on multiple columns
  • Chart: supports line (including multi-line) charts, bar charts (grouped and stacked) and scatter plot
  • Create column: make a new column with basic math or use PRQL functions
  • Remove columns: easily add/remove columns with visual toggles
  • Table: add a table in the middle of your workflow to visualize data in a intermediate step
  • Download: export your transformed data in CSV

Known Bugs

  • Dates are sometimes parsed incorrectly - existing GH issue here
  • Table panel is slow for large datasets. We're planning on moving to a canvas based table
  • [Rare] Charts axes can sometimes not be ordered correctly

Please report any bugs you find in GitHub issues.

Contact

You can email us at founders [at] withpretzel [dot] com.

We also read all the feedback and bugs you report at the top left of https://pretzelai.github.io