zeba_academy_offline_db

🚀 A powerful offline‑first database system for Flutter with hybrid storage, automatic background synchronization, and encrypted local data.

This package helps Flutter developers build offline‑capable apps using SQLite + Hive hybrid storage, ensuring reliable data persistence even without internet connectivity.

✨ Features

  • 📦 Offline‑first architecture
  • 🗄 Hybrid database system (SQLite + Hive)
  • 🔐 Encrypted local storage
  • 🔄 Automatic background API synchronization
  • ⚡ Offline API request queue
  • 🔁 Automatic retry system
  • 📡 Connectivity‑based sync
  • 🔔 Stream‑based live data updates
  • 🧠 Conflict resolution system
  • 📱 Built specifically for Flutter apps

📸 Screenshots

Add screenshots inside a screenshots/ folder.

screenshots/
   offline_ui.png
   offline_records.png
   offline_add.png

Example:

![Offline Database UI](screenshots/offline_ui.png)
![Stored Records](screenshots/offline_records.png)

📦 Installation

Add the package to your pubspec.yaml:

dependencies:
  zeba_academy_offline_db: ^1.0.0

Then run:

flutter pub get

🚀 Quick Start

Initialize the database and start the sync service.

import 'package:zeba_academy_offline_db/zeba_academy_offline_db.dart';

void main() async {

  WidgetsFlutterBinding.ensureInitialized();

  await HiveService.init();

  SyncService.start();

  runApp(MyApp());
}

🗄 Insert Data (Offline)

await DatabaseService.insertRecord({
  "id": "1",
  "data": "Hello Offline World",
  "updatedAt": DateTime.now().millisecondsSinceEpoch
});

📥 Read Stored Records

final records = await DatabaseService.getRecords();

📡 Offline API Queue

Queue API requests when the device is offline.

RequestQueue.add(
  ApiRequest(
    url: "https://api.example.com/data",
    method: "POST",
  ),
);

The package will automatically:

  • retry failed requests
  • sync when internet connection returns
  • maintain queue integrity

🔔 Live Data Streams

Use reactive streams to update UI automatically.

final stream = DataStream<String>();

stream.update(["Item 1","Item 2"]);

stream.stream.listen((data){
  print(data);
});

🧠 Architecture

The package uses a hybrid storage architecture:

Flutter App
     │
     ▼
Offline Database Layer
     │
 ┌───────────────┐
 │   SQLite DB   │  → Persistent structured storage
 └───────────────┘
     │
 ┌───────────────┐
 │     Hive      │  → Fast local cache
 └───────────────┘
     │
     ▼
Sync Engine
     │
Offline Request Queue
     │
API Server

📁 Example

A complete example app is included in the /example folder.

Run it with:

cd example
flutter run

🧪 Running Tests

flutter test

📜 License

This project is licensed under the GPL License.

👨‍💻 About Me

✨ I’m Sufyan bin Uzayr, an open‑source developer passionate about building and sharing meaningful projects.

You can learn more about me and my work at:

https://sufyanism.com/

Connect with me on LinkedIn:

https://www.linkedin.com/in/sufyanism

🎓 Zeba Academy

Your all‑in‑one learning hub!

🚀 Explore courses and resources in coding, tech, and development at zeba.academy and code.zeba.academy.

Empower yourself with practical skills through curated tutorials, real‑world projects, and hands‑on experience. Level up your tech game today! 💻✨

Zeba Academy is a learning platform dedicated to coding, technology, and development.

➡ Visit our main site: https://zeba.academy

➡ Explore hands‑on courses and resources: https://code.zeba.academy

➡ Check out our YouTube for tutorials: https://www.youtube.com/@zeba.academy

➡ Follow us on Instagram: https://www.instagram.com/zeba.academy/

⭐ If you find this package useful, consider starring the repository and sharing it with others.

Libraries

zeba_academy_offline_db