ReadRealm transforms how people discover, read, and discuss books. Whether you’re on Android, iOS, or the web — your library, conversations, and reading progress sync instantly. Powered by advanced AI and built on cloud infrastructure, ReadRealm lets readers go beyond the page.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/aliammari1/readrealm/llms.txt
Use this file to discover all available pages before exploring further.
Why ReadRealm?
| Problem | ReadRealm solution |
|---|---|
| Scattered reading across devices | Android & iOS client apps plus a Flutter admin dashboard — your library everywhere |
| Passive reading experience | AI-powered insights, smart recommendations, and real-time chat |
| Reading in isolation | Engage with AI assistants and other readers instantly |
| Text-heavy interfaces | Voice commands and audio narration with Azure Cognitive Services |
| Sync headaches | Automatic cross-platform sync in milliseconds |
The four apps
Android client
Native reading app built with Kotlin and Jetpack Compose. Targets Android SDK 24+ and delivers a full e-reader experience for end users.
iOS client
Native reading app built with Swift. Requires Xcode 15+ on macOS and mirrors the full feature set of the Android client.
Flutter admin dashboard
Cross-platform management interface built with Flutter 3.20+. Runs on web, Windows, and macOS for library administration and analytics.
NestJS backend API
The single source of truth for all clients. Built on NestJS 10 with TypeScript, MongoDB, Socket.IO, and integrations for Google AI, HuggingFace, and Azure Cognitive Services.
Key features
Intelligent library management
Organize thousands of books with AI-powered categorization, smart search, and personalized recommendations based on reading habits.
Real-time collaborative chat
Discuss books with AI assistants and other readers instantly. Socket.IO powers millisecond-latency conversations that sync across all devices.
AI-powered insights
Auto-generated summaries, key point extraction, Q&A generation, and smart recommendations via Google Generative AI and HuggingFace.
Voice integration
Speech-to-text for hands-free interaction and AI-powered text-to-speech using Azure Cognitive Services. Real-time audio processing with FFmpeg.
Full EPUB support
Professional e-book rendering with rich formatting, embedded fonts, images, and styling. No compromises on reading quality.
Enterprise-grade security
JWT-based authentication, email verification, secure password hashing, and API key management for all AI service integrations.
Tech stack at a glance
| Layer | Technology | Purpose |
|---|---|---|
| Android | Kotlin + Jetpack Compose | Native mobile reading app for end users |
| iOS | Swift | Native mobile reading app for end users |
| Admin dashboard | Flutter (Web / Desktop / macOS) | Library management and analytics |
| Backend API | NestJS 10 + TypeScript | Serves all clients, manages data and AI |
| Database | MongoDB with Mongoose ORM | Scalable data persistence |
| Real-time | Socket.IO | Instant chat and collaboration |
| AI services | Google AI, HuggingFace, Azure Cognitive | Insights, recommendations, and voice |
Next steps
Quickstart
Get ReadRealm running locally in under 30 seconds.
System architecture
Understand how all four apps connect and communicate.