FLUTTER ECOSYSTEM

vikram-vikky2002/flutter_fire

这个Flutter包名为flutter_fire,为您的Flutter应用程序提供了便捷且高效的Firebase认证和Firestore操作访问。

flutter_fire 项目封面
Stars
1
Forks
0
最近推送(UTC)
2024年4月15日
项目状态
未归档
VIKRAM K R GitHub avatar
GITHUB User

VIKRAM K R ↗

A passionate Full-Stack Android developer from India 🌟✨

语言Dart

技术话题

此仓库发布的插件

使用的依赖

依赖清单 8 项

原始 README

以下为英文项目原文快照,最新内容请访问 GitHub。

展开 / 收起项目 README

FLUTTER FIRE 🔥

This Flutter package, named flutter_fire, provides convenient and streamlined access to Firebase Authentication and Firestore operations within your Flutter applications. It simplifies tasks such as user authentication via email/password and Google Sign-In, as well as common Firestore operations like retrieving single documents, fetching all documents in a collection, and streaming data updates. With its intuitive methods, flutter_fire aims to enhance your development experience by seamlessly integrating Firebase services into your Flutter projects.

https://github.com/vikram-vikky2002/flutter_fire/blob/main/files/NEW%20LOGO.png?raw=true

Features

  1. Authentication:

    • Sign in with email and password.
    • Create a new user with email and password.
    • Sign in with Google authentication.
  2. Firebase Firestore Operations:

    • Find a single document by ID.
    • Find all documents in a collection.
    • Get a stream of data from a Firestore collection.
    • Retrieve data from a Firestore collection.
    • Find a list of documents present in a list of document IDs and return them as a stream.
  3. Convenience Features:

    • Access to the current user.
    • Stream for authentication state changes.

Getting started

Prerequisites
  1. Flutter Setup: Ensure you have Flutter installed on your system. You can find installation instructions on the official Flutter website.

  2. Firebase Account: Create a Firebase account if you haven't already. You can sign up for free on the Firebase website.

@echo off

echo Firebase Login checking...
call firebase login
echo Adding Firebase plugins to the Flutter project...
call firebase init
echo Adding Firebase plugins to the Flutter project...
call flutter pub add firebase_core firebase_auth cloud_firestore
echo Running Flutter project...
call flutter run

To use this script, create a new text file in your project directory, name it firebase_init.bat, and paste the above code into it. Then, you can simply run this file from the command line to set up Firebase and add the necessary plugins to your Flutter project. Make sure you have both the Firebase CLI and Flutter installed and configured on your system before running this script.

Usage

import 'package:flutter_fire/flutter_fire.dart';

1. Authentication :

// Initialize FlutterFire instance
FlutterFire flutterFire = FlutterFire();

// Sign in with email and password
await flutterFire.signInWithEmailAndPassword(email: 'example@email.com', password: 'password');

// Create a new user with email and password
await flutterFire.createUserWithEmailAndPassword(email: 'newuser@email.com', password: 'newpassword');

// Sign in with Google authentication
await flutterFire.signInWithGoogle();

2. Firestore Operations :

// Get a single document by ID
Map<String, dynamic>? document = await flutterFire.findOne('collectionName', 'documentId');

// Get all documents in a collection
List<dynamic>? documents = await flutterFire.findAll('collectionName');

// Stream data from a Firestore collection
Stream<QuerySnapshot<Map<String, dynamic>>> stream = flutterFire.getStreamData('collectionName');

// Retrieve data from a Firestore collection
Map<String, dynamic> data = flutterFire.getData('collectionName');

// Find documents present in a list of document IDs and return them as a stream
Stream<List<Map<String, dynamic>>> docStream = flutterFire.findStreamContainingList('collectionName', 'documentId', ['id1', 'id2']);

3. Convenience Features:

// Access the current user
User? currentUser = flutterFire.currentUser;

// Stream for authentication state changes
Stream<User?> authStream = flutterFire.authStateChanges;

These examples showcase how to perform common authentication and Firestore operations using the flutter_fire package, making it easier for developers to integrate Firebase services into their Flutter applications.

https://github.com/vikram-vikky2002/flutter_fire/blob/main/files/screen1.png?raw=true