Home.md

Welcome to TopicsFlow Wiki

TopicsFlow is a real-time chat and topic discussion platform designed to facilitate focused conversations and community interactions.

📚 Documentation Index

• Getting Started: Setup guide for developers and users.
• Project Structure: Overview of the codebase layout.
• Backend Architecture: Details on the Flask backend, API, and services.
• Frontend Architecture: Guide to the Next.js frontend application.
• Database Schema: Comprehensive documentation of MongoDB models.
• API Reference: Key API endpoints and Socket.IO events.
• Deployment & DevOps: Instructions for deploying to Azure and using Docker.

🏗️ High-Level Architecture

graph TD
    User[User] -->|HTTP/WebSocket| Frontend[Next.js Frontend]
    Frontend -->|REST API| Backend[Flask Backend]
    Frontend -->|Socket.IO| Backend
    Backend -->|Read/Write| DB[(MongoDB/CosmosDB)]
    Backend -->|Cache/PubSub| Redis[(Redis)]
    Backend -->|Storage| Storage[Azure Blob / Local]

Loading

🚀 Key Features

• Real-time Chat: Instant messaging in topics and private groups.
• Topic Management: Create and manage discussion topics with granular permissions.
• Media Support: Share images, videos, and files.
• Role-Based Access: Granular permissions for Owners, Moderators, and Members.
• Moderation Tools: Reporting, banning, and content filtering.
• Secure Authentication: Passwordless login, TOTP support, and secure session management.