EdmaxLabs Core Flutter Package

EdmaxLabs Core is the official Flutter package for projects using Edmaxlabs Services. It provides unified access to your project’s database, cloud functions, and storage, making it easy to build real-time apps with minimal setup.


πŸš€ Features

  • Realtime database
  • Cloud functions
  • Storage
  • Unified singleton instance for all services

For full usage and advanced features, see EdmaxLabs Docs.


πŸ“¦ Installation

Add edmaxlabs_core to your pubspec.yaml:

dependencies:
  edmaxlabs_core: ^1.0.0

Then run:

flutter pub get

βš™οΈ Initialization

All project-specific data can be found in your EdmaxLabs console: https://console.edmaxlabs.com/settings.

import 'package:edmaxlabs_core/edmaxlabs_core.dart';
import 'package:flutter/material.dart';

void main() {
  final options = EdmaxLabsOptions(
    token: "xxxxx",
    project: "xxxxxxx",
    authToken: "xxxxx",
  );

  EdmaxLabs.initialize(options);

  runApp(const MyApp());
}

EdmaxLabs Console Settings Screenshot Screenshot: Project settings in EdmaxLabs Console


πŸ›  Usage Example

import 'package:edmaxlabs_core/edmaxlabs_core.dart';

// Get singleton instance
final db = EdmaxLabs.getInstance.getDatabase;
final fn = EdmaxLabs.getInstance.getFunctions;
final storage = EdmaxLabs.getInstance.getStorage;

// Call a function
final result = await fn.call("getAllTasksDemo");

// Listen to a collection
db.collection("tasks").onSnapshot((snap, event) {
  print("Snapshot ${snap.id} received: $event");
});

// Upload a file
final res = await storage.ref("myapp/file.png").uploadBytes(fileBytes, (percent) {
  print("Upload progress: $percent%");
});

🧩 Example App Structure

lib/
 β”œβ”€ models/      # Data models
 β”œβ”€ widgets/     # Reusable widgets
 β”œβ”€ screens/     # App screens
 └─ main.dart    # App entry point

πŸ“– Documentation

For detailed usage, advanced guides, and examples, see EdmaxLabs Docs.


🀝 Contributing

Contributions are welcome! Please fork the repo and submit a pull request.


πŸ“„ License

MIT License – see LICENSE.


Libraries

edmaxlabs_core