diRead

Your Private Family Digital Library
Read beautifully. Sync seamlessly. Own your books.

Why diRead • Features • Quick Start • Screenshots • Roadmap

---

📖 Why diRead?

Ever wanted your own private e-book library that just works?

diRead is built for families who:

• 📚 Have a personal collection of PDFs and EPUBs
• 🔒 Want their reading data private — no tracking, no ads
• 📱 Read across multiple devices and want everything synced
• ✨ Appreciate a clean, distraction-free reading experience

Think of it as your personal Apple Books — but you own the server too.

---

✨ Features

📱 Beautiful Reading Experience

Feature	Description
PDF & EPUB Support	High-quality rendering with Syncfusion PDF Viewer
6 Reading Themes	Light, Dark, Sepia, Blue, Green, Cream
3 Scroll Modes	Horizontal swipe, Vertical swipe, Continuous scroll
Smart Navigation	Slider, Go-to-page, Table of Contents
Bookmarks	One-tap bookmark with visual feedback (red when active)
Progress Tracking	Automatic save & sync across devices
Offline Reading	Downloaded books work without internet

🔐 Privacy & Security

• Your server, your data — Self-hosted backend
• Secure authentication — JWT tokens with refresh rotation
• Encrypted storage — Tokens stored in secure storage
• Per-user libraries — Each family member has private books
• No telemetry — Zero tracking, zero analytics

📲 Cross-Platform

Works everywhere you read:

Platform	Status
Android	✅ Ready
iOS	✅ Ready
Web Browser	✅ Ready
macOS	✅ Ready
Windows	✅ Ready
Linux	✅ Ready

---

🚀 Quick Start

What You Need

• Flutter SDK 3.1+
• Python 3.9+
• 10 minutes of your time ☕

Step 1: Clone & Setup Backend

# Clone the repository
git clone https://github.com/YOUR_USERNAME/diread.git
cd diread/backend

# Create virtual environment
python3 -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Start the server
python main.py

🎉 Backend running at http://localhost:8000

Step 2: Run the App

# From project root
cd ..
flutter pub get
flutter run

Step 3: Create Your Account

1. Open the app
2. Tap "Create Account"
3. Start uploading your books!

---

📸 Screenshots

Coming soon — beautiful screenshots of the reading experience

---

🎨 Reading Themes

Choose the theme that's easiest on your eyes:

Theme	Background	Best For
☀️ Light	Pure White	Bright environments
🌙 Dark	Deep Black	Night reading
📜 Sepia	Warm Beige	Long reading sessions
💙 Blue	Soft Blue	Reduced eye strain
🌿 Green	Calm Green	Relaxed reading
🍦 Cream	Soft Yellow	Comfortable contrast

---

📂 What Can You Upload?

Format	Max Size	Features
PDF	100 MB	Full rendering, zoom, scroll modes
EPUB	100 MB	Reflowable text, TOC, custom fonts

Automatic extraction of:

• 📖 Book title
• ✍️ Author name
• 🖼️ Cover image

---

🛠️ Tech Stack

Frontend (Flutter)

• Provider — State management
• go_router — Navigation with auth guards
• Dio — HTTP client with token refresh
• Syncfusion — PDF rendering
• flutter_secure_storage — Secure token storage

Backend (Python)

• FastAPI — Async REST API
• SQLAlchemy — Database ORM
• PyJWT — Authentication
• bcrypt — Password hashing
• pypdf + ebooklib — Metadata extraction

---

🗺️ Roadmap

✅ Version 1.0 (Current)

• PDF & EPUB reading
• 6 reading themes
• 3 scroll directions
• Bookmarks with visual feedback
• Session persistence (stay logged in)
• Splash screen
• Cross-platform support
• Offline reading
• Progress sync

🔜 Version 1.1 (Next)

• Full-text search inside books
• Highlights with notes
• Export annotations
• Reading statistics

🔮 Future

• Family sharing
• Book collections
• Text-to-speech
• Reading goals

---

📁 Project Structure

diread/
├── lib/                    # Flutter app
│   ├── core/               # Config, theme, utilities
│   ├── data/               # Models, repositories, API
│   └── presentation/       # UI screens & providers
│
├── backend/                # FastAPI server
│   ├── app/                # Routes, models, services
│   ├── main.py             # Entry point
│   └── requirements.txt    # Dependencies
│
└── assets/                 # Images, icons, fonts

---

🔧 Configuration

Backend (.env)

SECRET_KEY=your-super-secret-key
DATABASE_URL=sqlite+aiosqlite:///./diread.db
MAX_FILE_SIZE_MB=100

Frontend (app_config.dart)

static const String apiBaseUrl = 'http://YOUR_SERVER:8000/api/v1';

---

🚢 Deployment

Android Release

flutter build apk --release
# Output: build/app/outputs/flutter-apk/app-release.apk

Backend (Docker)

cd backend
docker build -t diread-api .
docker run -p 8000:8000 diread-api

---

🤝 Contributing

We welcome contributions! Here's how:

1. Fork the repository
2. Create your branch: git checkout -b feature/awesome
3. Commit changes: git commit -m 'Add awesome feature'
4. Push: git push origin feature/awesome
5. Open a Pull Request

---

📄 License

This project is designed for private/family use. See LICENSE for details.

---

🙏 Acknowledgments

Built with love using:

• Flutter — Beautiful cross-platform apps
• FastAPI — Modern Python API framework
• Syncfusion — PDF viewer component

---

Made with ❤️ for families who love reading together

_{diRead — Because your books deserve a beautiful home.}