OmkarBansod02/Databuddy

Databuddy is a privacy-first analytics platform with a focus on user experience, with it's foundation built on privacy, it ensures complete compliance with most major data privacy laws out of the box

โ˜… 0Forks 0GitHub โ†—Compare

Project website โ†—

README

Databuddy

License: AGPL TypeScript Next.js React Turborepo Bun Tailwind CSS

CodeRabbit Pull Request Reviews Code Coverage Security Scan Dependency Status

Vercel OSS Program

Discord GitHub Stars Twitter

A comprehensive analytics and data management platform built with Next.js, TypeScript, and modern web technologies. Databuddy provides real-time analytics, user tracking, and data visualization capabilities for web applications.

๐ŸŒŸ Features

  • ๐Ÿ“Š Real-time analytics dashboard
  • ๐Ÿ‘ฅ User behavior tracking
  • ๐Ÿ“ˆ Advanced data visualization // Soon
  • ๐Ÿ”’ Secure authentication
  • ๐Ÿ“ฑ Responsive design
  • ๐ŸŒ Multi-tenant support
  • ๐Ÿ”„ Real-time updates // Soon
  • ๐Ÿ“Š Custom metrics // Soon
  • ๐ŸŽฏ Goal tracking
  • ๐Ÿ“ˆ Conversion analytics
  • ๐Ÿ” Custom event tracking
  • ๐Ÿ“Š Funnel analysis
  • ๐Ÿ“ˆ Cohort analysis // Soon
  • ๐Ÿ”„ A/B testing // Soon
  • ๐Ÿ“ˆ Export capabilities
  • ๐Ÿ”’ GDPR compliance
  • ๐Ÿ” Data encryption
  • ๐Ÿ“Š API access

๐Ÿ“š Table of Contents

  1. How do I get started? Follow the Getting Started guide.

Prerequisites

  • Bun 1.3.14+
  • Node.js 20+

๐Ÿ  Self-Hosting

Databuddy can be self-hosted using Docker Compose. The repo includes two compose files:

File Purpose
docker-compose.yaml Development only โ€” starts infrastructure (Postgres, ClickHouse, Redis) for local dev
docker-compose.selfhost.yml Production / self-hosting โ€” backend services from GHCR images

Quick Start

# 1. Configure environment
cp .env.example .env
# Edit .env โ€” set IMAGE_TAG, URL-safe database/cache passwords, public URLs,
# BETTER_AUTH_SECRET, DATABUDDY_ENCRYPTION_KEY, IP_HASH_SALT, and
# AI_GATEWAY_API_KEY. Make the local database URLs use the same credentials
# before running the initialization commands below.

# 2. Start databases and cache
docker compose -f docker-compose.selfhost.yml up -d postgres clickhouse redis

# 3. Initialize databases from the repo checkout (first run only)
bun install --frozen-lockfile
bun run db:push
bun run clickhouse:init

# 4. Start backend services
docker compose -f docker-compose.selfhost.yml up -d

Services started:

  • API โ†’ localhost:3001
  • Basket (event ingestion) โ†’ localhost:4000
  • Insights (investigation worker) โ†’ localhost:4002
  • Links (short links) โ†’ localhost:2500

All ports are configurable via env vars (API_PORT, BASKET_PORT, etc.). See the compose file comments for the full env var reference.

๐Ÿค Contributing

See CONTRIBUTING.md for guidelines.

๐Ÿ”’ Security

See SECURITY.md for reporting vulnerabilities.

โ“ FAQ

General

  1. What is Databuddy? Databuddy is a comprehensive analytics and data management platform.

  2. How do I get started? Follow the Getting Started guide.

  3. Is it free? Check our pricing page.

Technical

  1. What are the system requirements? See Prerequisites.

  2. How do I deploy? See the deployment documentation in our docs.

  3. How do I contribute? See Contributing.

๐Ÿ’ฌ Support

๐Ÿ“„ License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). See the LICENSE file for details.

Copyright (c) 2025 Databuddy Analytics, Inc.

Contributors

izadoesdevTareqKameer2468sbansal1999akash3444dependabot[bot]haydenbleaselmezotvswamimalode07superlog-app[bot]sprettvagxrthAyanavaKarmakarSahil-Gupta584vachmaraHugoRCDdancersekhar08jaysu66r69shabhletstrisundaram2021eersningtonbodinsamuelblaisewfFindMalekgoksanaxelwesselgrenEverStarckkylegrahammatzen

Issues