TrendScout Documentation

This directory contains the core documentation for TrendScout, a cloud-native social media monitoring platform.

Documents Overview

Technical Stack

Comprehensive overview of the technology choices, including:

• Frontend: React + Vite + Tailwind CSS
• Backend: Go microservices on Cloud Run
• Database: MongoDB Atlas
• Infrastructure: Google Cloud Platform services
• Development environment setup and project structure

Project Description

Detailed technical architecture and implementation details:

• Core system components and data flow
• Microservices architecture breakdown
• Integration patterns and user workflows
• Development considerations and performance targets

Quick Start Development Commands

# Frontend development
cd frontend
npm install
npm run dev

# Backend development
cd backend
go mod tidy
go run cmd/api/main.go

# Full stack development
make dev  # Runs both frontend and backend

# Testing
make test  # Runs all tests
make test-frontend  # Frontend tests only
make test-backend   # Backend tests only

# Build and deployment
make build    # Build for production
make deploy   # Deploy to GCP

Architecture Summary

TrendScout uses a serverless microservices architecture on Google Cloud Platform:

Frontend (React) → API Gateway → Microservices (Go) → MongoDB Atlas
     ↓                ↓              ↓
   GCS + CDN      Cloud Run    Cloud Run Services

Key Design Principles

1. Cloud-Native: Built for GCP with serverless technologies
2. Microservices: Loosely coupled, independently deployable services
3. Event-Driven: Asynchronous processing with Pub/Sub messaging
4. Cost-Optimized: Pay-per-use model for maximum efficiency
5. Developer-Friendly: Modern tools and automated workflows

Development Workflow

1. Local Development: Hot reload for both frontend and backend
2. Testing: Comprehensive test suites with CI integration
3. Deployment: Automated CI/CD via GitHub Actions
4. Monitoring: Built-in observability with GCP monitoring

For detailed information, see the individual documentation files.