← Back to Table of Contents

Open Source Site Tracking

A comprehensive analytics platform for open source projects

Overview Features Quick Start Installation Documentation Contributing

Overview

Open Source Site Tracking is a powerful, self-hosted analytics platform designed specifically for open source projects. It provides comprehensive insights into user behavior, project engagement, and website performance without compromising user privacy.

Key Benefits

  • Privacy-First: No third-party tracking or data sharing
  • Self-Hosted: Complete control over your data
  • Open Source: MIT License - use, modify, and distribute freely
  • Developer-Friendly: Built with modern web technologies
  • Feature-Rich: Advanced analytics and reporting capabilities

Features

📊 Real-time Analytics

Live tracking of page views, visitors, and user interactions with real-time dashboard updates.

🎯 Conversion Funnels

Track user journeys through your site with customizable conversion funnels and drop-off analysis.

🗺️ Heat Maps

Visual representation of user clicks, scrolls, and mouse movements to understand user behavior.

📝 Form Analytics

Detailed tracking of form interactions, completion rates, and abandonment analysis.

👥 User Management

Team collaboration with role-based access control and user invitation system.

🔒 Privacy-Focused

No cookies, no personal data collection, and full GDPR compliance.

Quick Start

Get Started in Minutes

  1. Clone the repository 
    git clone https://github.com/AutoBotSolutions/Opensource-Site-Tracking.git
cd opensource-site-tracking
  2. Start with Docker 
    docker-compose up -d
  3. Access the dashboard

    Open http://localhost:3000 in your browser

  4. Add tracking code 
    <script src="http://localhost:8000/tracking.js" 
        data-project-id="your-project-id"></script>

Installation

System Requirements

Installation Methods

Docker Installation (Recommended)

# Clone the repository
git clone https://github.com/AutoBotSolutions/Opensource-Site-Tracking.git
cd opensource-site-tracking
# Start the services
docker-compose up -d
# Check status
docker-compose ps

Manual Installation

# Backend setup
cd backend
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt
python init_db.py
uvicorn main:app --reload
# Frontend setup
cd frontend
npm install
npm run dev

Documentation

Comprehensive documentation is available to help you get the most out of the platform:

Getting Started

Beginner-friendly guide to get you up and running quickly.

Installation Guide

Detailed installation instructions for all environments.

API Documentation

Complete API reference for developers and integrations.

Development Guide

Contributing and development instructions.

FAQ

Frequently asked questions and common issues.

Support

Get help and support from the community.

Contributing

We welcome contributions from the community! Whether you're fixing bugs, adding features, or improving documentation, your help is appreciated.

Ways to Contribute

Development Setup

  1. Fork the repository on GitHub
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Commit your changes: git commit -m 'Add amazing feature'
  4. Push to the branch: git push origin feature/amazing-feature
  5. Open a Pull Request

Community

Join our community to connect with other users and developers:

License

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

Thank You!

Thank you for your interest in Open Source Site Tracking. We're excited to see what you build with it!

Together, we're building the future of open source analytics. 🚀