Skip to main content

AI content reporpuser - Documentation

Welcome to the AI content reporpuser documentation! This comprehensive guide will help you set up, configure, and use the application.

📚 Documentation Index​

🚀 Quick Start​

Prerequisites​

  • Node.js 18+ and npm
  • Flutter 3.10+ (for desktop/mobile app)
  • OpenAI API key (required)
  • Firebase project (optional, for data persistence)

Installation (5 minutes)​

# 1. Clone and navigate to project
cd AI_reporpuser

# 2. Setup backend
cd scripts
./setup-backend.sh

# 3. Setup frontend
./setup-frontend.sh

# 4. Configure environment
cp ../backend/.env.example ../backend/.env
# Edit .env with your API keys

# 5. Start the application
./start-dev.sh

📦 What's Included​

Backend (Node.js + Express + TypeScript)​

  • ✅ AI-powered content generation
  • ✅ Multiple platform support (Twitter, LinkedIn, Facebook, Instagram, etc.)
  • ✅ Tone customization (Professional, Casual, Friendly, etc.)
  • ✅ Firebase integration for data persistence
  • ✅ Content ingestion from URLs
  • ✅ Structured logging
  • ✅ Error handling

Frontend (Flutter Desktop/Mobile)​

  • ✅ Modern, responsive UI
  • ✅ Real-time generation status
  • ✅ Dark mode support
  • ✅ Generation history
  • ✅ Platform-specific content cards
  • ✅ Copy to clipboard
  • ✅ Export functionality

🎯 Key Features​

  1. Multi-Platform Content Generation

    • Generate optimized content for 10+ social platforms
    • Automatic character limits and formatting
    • Platform-specific hashtags and mentions

  2. Intelligent Tone Adaptation

    • Professional, Casual, Friendly, Formal, Humorous, Inspirational
    • Context-aware tone application
    • Consistent voice across platforms

  3. Flexible Input

    • Direct text input
    • URL content extraction
    • Automatic content cleaning

  4. Data Persistence

    • Firebase integration
    • Generation history
    • User settings
    • Analytics tracking

  5. Developer Friendly

    • Well-documented API
    • TypeScript + Type safety
    • Modular architecture
    • Easy to extend

🔧 System Requirements​

Backend​

  • OS: Linux, macOS, or Windows
  • Node.js: 18.x or higher
  • Memory: 512MB minimum
  • Storage: 100MB

Frontend​

  • OS: Linux (tested), macOS, Windows, Android, iOS
  • Flutter: 3.10 or higher
  • Memory: 1GB minimum
  • Storage: 200MB

📖 Documentation Guide​

For First-Time Users​

  1. Start with Installation Guide
  2. Follow Configuration Guide
  3. Read User Guide

For Developers​

  1. Review Architecture
  2. See Deployment Guide

Need Help?​

  • Check Troubleshooting
  • Review logs in backend/logs/
  • Check environment configuration

📝 License​

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

🤝 Support​

For issues and questions:

  • Check documentation first
  • Review troubleshooting guide
  • Check backend logs for errors
  • Verify environment variables

🔄 Updates​

Keep your installation up to date:

# Backend updates
cd backend
npm install
npm run build

# Frontend updates
cd frontend
flutter pub get
flutter build linux  # or your platform

Next Steps: Start with the Installation Guide →