Skip to content

This Laravel library provides an Eloquent-like interface for interacting with Firestore, Google Cloud's NoSQL database.

License

Notifications You must be signed in to change notification settings

Freddywhest/firestore-eloquent

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Laravel Firestore Eloquent


Logo


This package is a customized version of Laravel Eloquent designed for seamless integration with Google Firestore within Laravel applications. Firestore boasts exceptional scalability and speed, but it provides a more limited feature set compared to conventional SQL databases.

Table of Contents

Requirements

Installation

  1. Install this package using composer

     composer require roddy/firestore-eloquent
  2. Add the following line to the service providers array within your config/app.php file:

    Roddy\FirestoreEloquent\Providers\FModelProvider::class,
  3. Copy and paste this to your .env file and replace path/to/firebase-credentials.json with the path to your credentials json file.

    GOOGLE_APPLICATION_CREDENTIALS=path/to/firebase-credentials.json
  4. Copy and paste this to your .env file and replace https://<your-project>.firebaseio.com with the database URL for your project. You can find the database URL for your project at https://console.firebase.google.com/u/project/_/settings/general

     FIREBASE_DATABASE_URL=https://<your-project>.firebaseio.com
  5. Copy and paste this to your .env file and replace your-project-id with your project id.

    FIREBASE_PROJECT_ID=your-project-id
  6. Publish the package configuration using Artisan

    php artisan vendor:publish --provider="Roddy\FirestoreEloquent\Providers\FModelProvider" --force

You can locate the configuration file in config/firebase.php.

Documentation

Visit Laravel Firestore Eloquent for documentation.

OR

Use this link https://firestore-eloquent.netlify.app/

Limitations

Limitations for documentation.

TODO

Todo for documentation.

License

The MIT License (MIT). Please see License File for more information.

Acknowledgments

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community.