README

Laravel Firestore Eloquent

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
• Documentation
• Limitations
• Contributing
• Changelog
• License

Requirements

• PHP >= 8.1
• Laravel >= 9 (Recommeded Latest Laravel)
• Composer

Installation

1. Install this package using composer

    composer require roddy/firestore-eloquent

2. Copy and paste this to your .env file and replace your-project-id with your project id.

   FIREBASE_PROJECT_ID=your-project-id

3. 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

• Laravel
• Google Cloud Firestore
• Google Cloud Firestore Storage
• PHP

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.