GTRACK Documentation

Welcome to the comprehensive technical documentation for GTRACK.

Overview

GTRACK is a comprehensive SaaS solution for monitoring and managing Google Business Profiles. It provides tools for SEO tracking, review management, and automated reporting.

Technology Stack:

• Frontend: Vue 3.4.21 (Composition API) + Vite 5.1.6 + PrimeVue 4.0.7 + Tailwind CSS 4.0.0
• Backend: Convex 1.29.3 (Backend-as-a-Service)
• External APIs: DataForSEO, Google Maps Platform

Key Features

• Rank Tracking: Monitor keyword positions in Google Maps and Search
• Review Management: Aggregate and reply to reviews with AI assistance
• SEO Audits: Analyze on-page SEO factors using DataForSEO
• Feature Gating: Multi-tier subscription plans (Basic, Professional, Enterprise)
• Real-time Updates: Automatic UI synchronization with backend changes
• Map Visualization: Interactive grid-based ranking visualization

Quick Start

1. New to GTRACK? Start with Architecture Overview to understand the system
2. Setting up? Follow Setup & Development Guide
3. Developing features? Check Development Workflow (coming soon)
4. Using the API? See Convex API Reference and External Integrations

Documentation Structure

Architecture

• Overview: System architecture, technology stack, design principles
• Backend (Convex): Database schema, functions, security model
• Frontend (Vue): Component structure, state management, routing
• Data Flow: Data flow patterns for each module
• Data Evolution: Migration status (mock vs real data)

Components

• Views: Page-level components (LocationMapView, LocationSettingsView, PublicFeedbackView)
• Reviews Components: Reviews module components (coming soon)
• Settings Components: Settings module components (coming soon)
• Map Components: Map visualization components (coming soon)
• Common Components: Shared UI components (coming soon)

Composables & Stores

• useFeatures: Feature checking and limit management
• featureSettings Store: Global state for subscription and features
• More composables documentation (coming soon)

API Reference

• Convex API: Complete reference for all backend functions
• External Integrations: DataForSEO and Google Maps API integration

Features & Limits

• Feature System: Feature configuration and hierarchy
• Plans & Limits: Subscription plans and limit enforcement
• Debug Bar: Development tool for testing features
• Keywords: Keyword tracking feature
• Reviews: Review management feature
• SEO Audits: SEO audit feature

Views & UI

• Dashboard (Map): Main dashboard view
• Reviews Module: Reviews management interface
• Settings Module: Settings configuration interface

Guides

• Setup & Development: Installation and development setup
• Deployment: Production deployment guide
• New Feature Guide: How to add new features

Documentation Principles

This documentation is designed to be:

• Comprehensive: Covers all aspects of the system
• Detailed: Includes code examples, data structures, and workflows
• Up-to-date: Reflects current implementation state
• AI-Friendly: Structured for easy understanding by AI systems

Contributing

When adding new features or making changes:

1. Update relevant documentation sections
2. Add code examples where applicable
3. Document data structures and API changes
4. Update migration status in Data Evolution

Related Resources

• Convex Documentation
• Vue 3 Documentation
• PrimeVue Documentation
• DataForSEO API Documentation