Databuddy

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.

• Contributing
• Security
• FAQ
• Support
• License

Prerequisites

• Bun 1.3.4+
• 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, database/cache passwords, URLs, BETTER_AUTH_SECRET, and BETTER_AUTH_URL

# 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
• Links (short links) → localhost:2500
• Uptime monitoring is optional — uncomment in the compose file to run the Redis-backed BullMQ worker.

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

• Documentation
• Discord
• Twitter
• GitHub Issues
• Email 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 © 2025 Databuddy Analytics, Inc.