Skip to content

README.md

Latest commit

 

History

History
130 lines (94 loc) · 5.1 KB

README.md

File metadata and controls

130 lines (94 loc) · 5.1 KB

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 // Soon
  • 🔒 GDPR compliance
  • 🔐 Data encryption
  • 📊 API access

📚 Table of Contents

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

Prerequisites

  • Bun

🤝 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

🙏 Acknowledgments

See ACKNOWLEDGMENTS.md for credits.

⚠️ Coding Standards & Rules

  • Bun is required for all development and scripts. Do not use npm, pnpm, or Node.js CLI for install, run, or dev.
  • Zod v4 (from zod/v4) is required everywhere. Do not use Zod v3.
  • Use only Phosphor icons (not Lucide).
  • Use Dayjs for date handling (never date-fns).
  • Use Tanstack Query for hooks (never SWR).
  • Use rounded for border radius (never rounded-xl or rounded-md).
  • Never add placeholders or mock data.
  • Always ensure type-safety and use shared types where possible.
  • Never throw errors in server actions; use try/catch and return errors to the client.
  • Always use error boundaries properly.
  • Console usage: Use console.error, console.time, console.json, console.table, etc. appropriately.
  • Almost never use useEffect unless critical.
  • Use Ultracite for linting and formatting.
  • Use Prettier for code formatting.

See .cursor/rules/ for the full enforced ruleset.