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 across all your devices.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.
Quick Start
Get ReadRealm running in minutes with step-by-step setup instructions.
Architecture
Understand how the backend, mobile apps, and admin dashboard fit together.
API Reference
Explore the full REST API and WebSocket interface.
Contributing
Learn how to contribute to ReadRealm across all platforms.
What you can do with ReadRealm
Intelligent Library
Organize thousands of books with AI-powered categorization, smart search, and personalized recommendations.
Real-time Chat
Discuss books with other readers instantly in per-book chat rooms powered by Socket.IO.
AI Insights
Get AI-generated summaries, key point extraction, and Q&A generation via Google AI and HuggingFace.
Voice Integration
Listen to books with Azure text-to-speech or use voice commands with speech-to-text.
EPUB Reading
Professional e-book rendering with full formatting, fonts, images, and styling support.
Cross-Platform Sync
Read on Android in the morning, continue on iOS at lunch — progress syncs automatically.
Get started
Set up the backend
Clone the repository, configure your environment variables, and start the NestJS API server.
See the environment setup guide for all required configuration.
Choose your client
Install the Android app or iOS app for mobile reading,
or run the Flutter admin dashboard to manage your library.
Configure AI services
Add your Google AI, HuggingFace, and Azure Cognitive Services API keys to unlock AI-powered summaries, recommendations, and voice features.
Platform support
| Platform | Technology | Purpose |
|---|---|---|
| Android | Kotlin + Jetpack Compose | Native mobile reading app |
| iOS | Swift | Native mobile reading app |
| Admin Dashboard | Flutter (Web/Desktop) | Library management & analytics |
| Backend API | NestJS + TypeScript | Core server for all clients |