Skip to content

Latest commit

 

History

History
166 lines (115 loc) · 3.73 KB

README.md

File metadata and controls

166 lines (115 loc) · 3.73 KB
QDash Logo

QDash

Privacy-First, AI-Powered Data Visualization

Quick Start • Privacy & Security

QDash is a powerful, browser-based dashboard that lets you visualize and analyze your data with AI assistance, without compromising privacy. Your data stays on your computer - always.

Privacy & Security

QDash prioritizes your privacy above all else:

  • Local Processing: All your data stays on your computer and never leaves your browser
  • No Data Sharing: Your sensitive data is never sent to external servers or AI models
  • AI-Powered, Privacy-Preserved: While QDash uses AI for intelligent decision-making and visualization suggestions, the AI never sees your actual data
  • Complete Control: You maintain full ownership and control of your data at all times

Quick Start

Option 1: Use the Hosted Version (Recommended)

Visit app.qdash.site to start using QDash immediately - no installation required!

Option 2: Self-Host

If you prefer to run QDash locally:

  1. Install dependencies:
npm install
  1. Set up environment:
cp .env.example .env
# Add your OpenAI API key to .env
  1. Start the server:
npm run local
  1. Open http://localhost:3000 in your browser

Features

  • 🔒 Complete privacy - your data never leaves your computer
  • 🛡️ Local-first processing - all computations happen in your browser
  • 📊 AI-powered chart generation
  • 💬 Natural language queries
  • 📈 Interactive data visualization
  • 📁 CSV file support
  • 🤖 OpenAI integration (for decision-making only, never sees your data)

Usage Guide

Creating Your First Dashboard

  1. Navigate to http://localhost:3000
  2. Click the "Upload CSV" button and select a CSV file
  3. Start querying in natural language to create your first dashboard

Using AI Features

QDash understands natural language commands. Try these examples:

  • "Create a bar chart showing sales by region"
  • "Show me a line graph of monthly revenue"
  • "Generate a pie chart of customer demographics"
  • "Plot the trend of website traffic over time"

Tips for Best Results

  1. Data Preparation:

    • Ensure your CSV files have clear column headers
    • Clean your data before uploading
    • Remove any unnecessary columns

  2. Query Tips:

    • Be specific about the chart type you want
    • Mention the columns or metrics you're interested in
    • Specify any filters or time ranges

Development Setup

Prerequisites

  • Node.js 18 or higher
  • npm or yarn
  • OpenAI API key

Environment Variables

Create a .env file with:

OPENAI_API_KEY=your_openai_api_key

Local Development

  1. Install dependencies:
npm install
  1. Start development server:
npm run dev:local
  1. Build for production:
npm run build

Deployment Options

Local Deployment (Recommended)

This is the standard way to run QDash. No Cloudflare account required.

  1. Build the application:
npm run build
  1. Start the local server:
npm run local

Your dashboard will be available at http://localhost:3000

Troubleshooting

Common Issues

  1. OpenAI API Issues

    • Check your API key in .env
    • Verify API credits/quota

  2. Server Issues

    • Ensure port 3000 is available
    • Check Node.js version (18+)

  3. Data Issues

    • Verify CSV format
    • Check file encoding (UTF-8)

Contributing

  1. Fork the repository
  2. Create your feature branch
  3. Commit your changes
  4. Push to the branch
  5. Create a Pull Request

License

This project is licensed under the MIT License. See the LICENSE file for details.