Technical documentation for contributors to the TendSocial platform.
🚀 Quick Start
- Planning: Use GitHub Projects (#2) for tracking work
- Workflow: See GitHub Workflow for issue and PR process
- Standards: Review Documentation Standard and Naming Conventions
- Setup: Follow Contributing Guide for local development
📋 Onboarding & Workflow
- GitHub Workflow: Issue creation, AI agent usage, PR process
- Contributing Guide: Local development setup and PR process
📝 Standards
- Coding Standards: Code style and best practices
- Documentation Standard: How to organize and maintain docs
- Naming Conventions: Code, route, and file naming rules
- Testing Conventions: Master testing guidelines and conventions
- AI Agent Context: Context for AI coding agents
🏗️ Architecture
- Overview: High-level system design
- Tech Stack: Technologies and versions (Node 22, Prisma 7, React 19)
- Database Schema: Prisma models and relationships
- Multi-Tenancy: Agency scaling and context switching
- Cloud Tasks: Async job processing with Google Cloud Tasks
⚙️ Features
AI & Content
- AI Configuration: AI model setup and Vercel AI Gateway
- Campaigns: Campaign management
- Blog Posts: Blog content creation and publishing
- Video Scripts: Video content generation
- Approvals: Content approval workflow
Publishing
- Platform Connections: OAuth and social platform APIs
- Social Media Publishing: Post scheduling and publishing
- Queues: Publishing queue management
- Bulk Import: CSV import for batch content
Engagement
- Inbox: Unified social media inbox
Analytics & Reporting
Team & Settings
- Company Settings: Company configuration
- Roles & Permissions: Role management and RBAC
- Team Integrations: Slack, Discord, Teams
- Review Access: External stakeholder review
Billing
Platform Admin
- Platform Console: Feature flags, segments, entitlements
- Admin Configuration: System settings and integrations
- Asset Library: Media management and storage
Infrastructure
- Background Jobs: Job processing and scheduling
- Email: Email service integration (Resend)
- Scraping: Web scraping service
- Storage: R2/S3 storage implementation
🚀 Deployment
- Deployment Guide: How to deploy to production
- Deployment Checklist: Pre-deployment verification
- Checklist v2: Enhanced deployment checklist
🔧 Operations
- Storage: R2/S3 file storage configuration
- CDN Setup: Cloudflare CDN configuration
- Backup & Restore: Database backup procedures
- Monitoring: System health monitoring
- Troubleshooting: Common issues and solutions
- Rollback: Rollback procedures
🎯 Performance
- Caching Strategies: Response and prompt caching
📊 Project Status
- Current Version: v4.2+
- Active Development: GitHub Projects (#2)
- Latest Migration: Database model renames (Company*/User* tier prefixes)
🔗 Related Documentation
- API Documentation - Public API reference
- Client Documentation - User-facing feature docs