simple_firebase 0.0.2

A qol package to simplify the process of handling firebase.

Feature Overview

Component	Supported Platforms	Supported Methods
Authentication	iOS, Android, Web, Windows*	Email/Password, Google Sign-In, Register, Sign Out
Firestore	iOS, Android, Web, Windows*	Create, Read, Update, Delete, Observe Real-time Changes
Realtime DB	iOS, Android, Web, Windows*	Create, Read, Update, Delete, Observe Real-time Changes
Storage	iOS, Android, Web, Windows*	Upload Single/Multiple Images, Get Download URLs, Check File Existence

*Works but has some issues from the original Firebase SDKs, mainly starting to observe the Firestore values prints a waarning.

The web support for the RealtimeDatabase is not provided by firebase defaultly so datapulling is necessary. Use only when needed and be careful with refreshtime.

Configuration

Before using Firebase Simplifier, ensure that your Firebase project is properly set up and configured in your Flutter application.

1. Firebase Project Setup

Create a Firebase Project:

• Navigate to the Firebase Console.
• Click on "Add project" and follow the prompts to create a new project.

Enable Firebase Services:

• Authentication: Go to Build > Authentication and enable the desired sign-in methods (e.g., Email/Password, Google).
• Firestore: Navigate to Build > Firestore Database and create a database.
• Realtime Database: Go to Build > Realtime Database and set up your database.
• Storage: Navigate to Build > Storage and configure your storage bucket.

2. Add Firebase Configuration Files

Android:

• In the Firebase Console, go to Project Settings > General > Your Apps > Add App > Android.
• Register your app and download the google-services.json file.
• Place the google-services.json file in the android/app/ directory of your Flutter project.

iOS:

• In the Firebase Console, go to Project Settings > General > Your Apps > Add App > iOS.
• Register your app and download the GoogleService-Info.plist file.
• Place the GoogleService-Info.plist file in the ios/Runner/ directory of your Flutter project.

3. Initialize Firebase in Your App

In your main.dart, initialize Firebase before running the app:

import 'package:flutter/material.dart';
import 'package:firebase_core/firebase_core.dart';
import 'package:firebase_simplifier/firebase_simplifier.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp();
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});
  
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Firebase Simplifier Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const HomePage(),
    );
  }
}

Usage

Firebase Simplifier provides various utilities to manage Firebase services seamlessly. Below are detailed usage instructions for each service.

Authentication

Email & Password

import 'package:firebase_simplifier/firebase_simplifier.dart';
import 'package:firebase_auth/firebase_auth.dart';

// Initialize Auth helper
final Auth auth = Auth();

// Sign in with email and password
auth.signInWithEmail(email, password).then((user) => print(user?.email ?? 'Sign-in failed'));

// Register a new user
auth.registerWithEmail(email, password).then((user) => print(user?.email ?? 'Registration failed'));

// Sign out
auth.signOut().then((_) => print('User signed out'));

Google Sign-In

import 'package:firebase_simplifier/firebase_simplifier.dart';
import 'package:firebase_auth/firebase_auth.dart';

// Initialize Auth helper
final Auth auth = Auth();

// Sign in with Google
auth.signInWithGoogle().then((user) => print(user?.email ?? 'Google sign-in failed'));

Firestore

import 'package:firebase_simplifier/firebase_simplifier.dart';

// Initialize Firestore helper
final SimpleFirestore firestore = SimpleFirestore();

// Write data to Firestore
firestore.writeData('collection/doc', data).then((success) => print(success ? 'Write success' : 'Write failed'));

// Read data from Firestore
firestore.getData('collection/doc').then((data) => print(data ?? 'No data found'));

// Delete data from Firestore
firestore.deleteData('collection/doc').then((success) => print(success ? 'Delete success' : 'Delete failed'));

// Create a unique document
firestore.createUniqueDocument('collection', data).then((docId) => print(docId ?? 'Create failed'));

Realtime Database (RTDB)

import 'package:firebase_simplifier/firebase_simplifier.dart';
import 'package:firebase_auth/firebase_auth.dart';

// Initialize RTDB helper
final RTDB rtdb = RTDB(currentUser, 'https://your-database-url.firebaseio.com/');

// Write data to RTDB
rtdb.writeData('path', data).then((success) => print(success ? 'Write success' : 'Write failed'));

// Read data from RTDB
rtdb.getData('path').then((data) => print(data ?? 'No data found'));

// Update data in RTDB
rtdb.updateData('path', data).then((success) => print(success ? 'Update success' : 'Update failed'));

// Delete data from RTDB
rtdb.deleteData('path').then((success) => print(success ? 'Delete success' : 'Delete failed'));

// Observe real-time data changes
rtdb.observeRealtimeDBValue('path').then((notifier) => notifier.addListener(() => print(notifier.value)));

Firebase Storage

import 'package:firebase_simplifier/firebase_simplifier.dart';
import 'dart:io';

// Initialize Storage helper
final BucketStorage storage = BucketStorage();

// Upload a single image
storage.uploadImage(file, userId).then((url) => print(url ?? 'Upload failed'));

// Upload multiple images
storage.uploadMultipleImages(files, userId).then((urls) => print(urls));

// Get download URL for an image
storage.getImageUrl('path').then((url) => print(url ?? 'URL not found'));

// Check if a file exists
storage.checkIfFileExists('path').then((exists) => print(exists ? 'File exists' : 'File does not exist'));

// Pick images using ImagePicker
storage.pickImages().then((images) => print(images.isNotEmpty ? 'Images picked' : 'No images selected'));

Examples

Below are example implementations demonstrating how to use Firebase Simplifier in your Flutter applications.

Example 1: Authentication Flow

import 'package:flutter/material.dart';
import 'package:firebase_simplifier/firebase_simplifier.dart';
import 'package:firebase_auth/firebase_auth.dart';

class AuthExamplePage extends StatefulWidget {
  const AuthExamplePage({Key? key}) : super(key: key);

  @override
  _AuthExamplePageState createState() => _AuthExamplePageState();
}

class _AuthExamplePageState extends State<AuthExamplePage> {
  final Auth _auth = Auth();
  final TextEditingController _emailController = TextEditingController();
  final TextEditingController _passwordController = TextEditingController();

  User? _user;

  @override
  void initState() {
    super.initState();
    _user = _auth.getCurrentUser();
  }

  Future<void> _signIn() async {
    User? user = await _auth.signInWithEmail(
      _emailController.text,
      _passwordController.text,
    );
    setState(() {
      _user = user;
    });
  }

  Future<void> _register() async {
    User? user = await _auth.registerWithEmail(
      _emailController.text,
      _passwordController.text,
    );
    setState(() {
      _user = user;
    });
  }

  Future<void> _signOut() async {
    await _auth.signOut();
    setState(() {
      _user = null;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
        appBar: AppBar(
          title: Text('Auth Example'),
        ),
        body: Padding(
          padding: const EdgeInsets.all(16.0),
          child: _user == null
              ? Column(
                  children: [
                    TextField(
                      controller: _emailController,
                      decoration: InputDecoration(labelText: 'Email'),
                    ),
                    TextField(
                      controller: _passwordController,
                      decoration: InputDecoration(labelText: 'Password'),
                      obscureText: true,
                    ),
                    ElevatedButton(
                      onPressed: _signIn,
                      child: Text('Sign In'),
                    ),
                    ElevatedButton(
                      onPressed: _register,
                      child: Text('Register'),
                    ),
                  ],
                )
              : Column(
                  children: [
                    Text('Signed in as ${_user!.email}'),
                    ElevatedButton(
                      onPressed: _signOut,
                      child: Text('Sign Out'),
                    ),
                  ],
                ),
        ));
  }
}

Example 2: Firestore CRUD Operations

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

class FirestoreExamplePage extends StatefulWidget {
  const FirestoreExamplePage({Key? key}) : super(key: key);

  @override
  _FirestoreExamplePageState createState() => _FirestoreExamplePageState();
}

class _FirestoreExamplePageState extends State<FirestoreExamplePage> {
  final SimpleFirestore _firestore = SimpleFirestore();
  final String _collection = 'users';
  final String _docId = 'user123';
  Map<String, dynamic>? _userData;

  @override
  void initState() {
    super.initState();
    _fetchUserData();
  }

  Future<void> _fetchUserData() async {
    Map<String, dynamic>? data = await _firestore.getData('$_collection/$_docId');
    setState(() {
      _userData = data;
    });
  }

  Future<void> _createOrUpdateUser() async {
    Map<String, dynamic> data = {
      'name': 'John Doe',
      'age': 30,
      'email': '[e-mail]',
    };
    bool success = await _firestore.writeData('$_collection/$_docId', data);
    if (success) {
      print('User data written successfully.');
      _fetchUserData();
    } else {
      print('Failed to write user data.');
    }
  }

  Future<void> _deleteUser() async {
    bool success = await _firestore.deleteData('$_collection/$_docId');
    if (success) {
      print('User data deleted successfully.');
      setState(() {
        _userData = null;
      });
    } else {
      print('Failed to delete user data.');
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
        appBar: AppBar(
          title: Text('Firestore Example'),
        ),
        body: Padding(
          padding: const EdgeInsets.all(16.0),
          child: Column(
            children: [
              _userData != null
                  ? Text('User Data: $_userData')
                  : Text('No user data available.'),
              ElevatedButton(
                onPressed: _createOrUpdateUser,
                child: Text('Create/Update User'),
              ),
              ElevatedButton(
                onPressed: _deleteUser,
                child: Text('Delete User'),
              ),
            ],
          ),
        ));
  }
}

Example 3: Realtime Database Operations

Refer to the Usage section for detailed examples on using the RTDB class.

Example 4: Firebase Storage Operations

Refer to the Usage section for detailed examples on using the Firebase Storage class.

Documentation

Comprehensive documentation is provided within the package to assist you in understanding and utilizing its full potential. Each class and method is thoroughly documented with explanations of parameters, return values, and usage examples.

Classes and Their Responsibilities

• Auth: Handles Firebase Authentication tasks including email/password and Google sign-in, registration, sign-out, and password reset.
• SimpleFirestore: Simplifies Firestore operations such as reading, writing, updating, deleting documents, and observing real-time changes.
• RTDB: Manages Realtime Database operations with rate limiting, CRUD functionalities, and real-time data observation.
• BucketStorage: Facilitates Firebase Storage operations including uploading single/multiple images, retrieving download URLs, and file management.

Getting Started

1. Initialize Firebase: Ensure Firebase is initialized in your main.dart.
2. Configure Firebase: Add the necessary configuration files (google-services.json, GoogleService-Info.plist).
3. Use Helper Classes: Instantiate and utilize the helper classes (Auth, SimpleFirestore, RTDB, BucketStorage) as demonstrated in the usage examples.

For detailed API references, refer to the inline documentation within each class file.

Contributing

Contributions are welcome! If you find a bug or have a feature request, please open an issue or submit a pull request.

Steps to Contribute

1. Fork the repository.
2. Create a new branch:

git checkout -b feature/YourFeatureName

3. Make your changes and commit them:

git commit -m "Add your message here"

4. Push to the branch:

git push origin feature/YourFeatureName

5. Open a pull request.

Guidelines

• Follow the existing code style and structure.
• Ensure that all new features are well-documented.

License

This project is licensed under the MIT License.

---

Contact

For any questions or support, please ask the flutter community over on discord. They have been a great support and will help you out for certain. https://discord.com/invite/rflutterdev

---

Acknowledgements

• Firebase
• Flutter
• Dart
• Image Picker

---

Example Project

Check out the example project demonstrating how to integrate Firebase Simplifier into a Flutter application.

---