Quick Start Guide

Prerequisites

Before you begin, make sure you have:

• Docker and Docker Compose installed
• Git for cloning the repository
• Command line access

5-Minute Setup

Step 1: Clone and Start 2 minutes

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

Step 2: Access the Application 30 seconds

Open your browser and navigate to:

• Frontend: http://localhost:3000
• Backend API: http://localhost:8000
• API Docs: http://localhost:8000/docs

Step 3: Create Your Account 1 minute

1. Click "Sign Up" on the homepage
2. Enter your email and create a password
3. Click "Create Account"
4. Log in with your new credentials

First Project

Create Your First Project 1 minute

1. Click "Add New Project" in the dashboard
2. Fill in the project details:
   • Name: My First Project
   • Repository URL: https://github.com/yourusername/your-repo
   • Description: My awesome open source project
3. Click "Create Project"
4. Copy your Project ID (you'll need this for tracking)

Tracking Setup

Add Tracking to Your Website 30 seconds

Add this single line of code to your website's <head> section:

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

Replace your-project-id with your actual Project ID from the previous step.

Example HTML

<!DOCTYPE html>
<html>
<head>
    <title>My Website</title>
    <script src="http://localhost:8000/tracking.js" 
            data-project-id="proj-abc123def456"></script>
</head>
<body>
    <h1>Welcome to My Website</h1>
    <p>This page is now being tracked!</p>
</body>
</html>

View Analytics

Check Your Analytics 30 seconds

1. Visit your website to generate some traffic
2. Go back to your project dashboard
3. Click "Analytics" in the sidebar
4. You should see:
   • Page Views: Real-time page view count
   • Unique Visitors: Number of unique visitors
   • Top Pages: Most visited pages
   • Geographic Data: Visitor locations

Next Steps

Explore Features

• Real-time Dashboard: Watch live analytics update
• Custom Reports: Create detailed reports
• User Management: Add team members
• API Access: Use the REST API
• Webhooks: Set up event notifications

Advanced Tracking

// Track custom events
SiteTracking.track('button-click', {
  button: 'signup',
  page: 'homepage'
});
// Track user actions
SiteTracking.track('form-submit', {
  form: 'contact',
  success: true
});
// Track page views manually
SiteTracking.track('page-view', {
  title: 'About Us',
  url: '/about'
});

Production Setup

• Change Tracking URL: Update to your production URL
• SSL Certificate: Enable HTTPS
• Custom Domain: Use your own domain
• Database Backup: Set up regular backups

Need Help?

• Documentation: Full Getting Started Guide
• API Reference: API Documentation
• Issues: GitHub Issues
• Discussions: GitHub Discussions

# Essential Commands
docker-compose up -d          # Start services
docker-compose down          # Stop services
docker-compose logs -f       # View logs
docker-compose ps             # Check status
# Development Commands
cd backend
python -m uvicorn main:app --reload
cd frontend
npm run dev

What's Next?

• Explore Documentation: Learn about all features
• Join Community: Connect with other users
• Contribute: Help improve the project
• Deploy to Production: Set up production environment
• Customize: Tailor the platform to your needs