Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rezuankassim/bqanalytic
Laravel package to use analytic data imported to Big Query from Firebase Analytic
https://github.com/rezuankassim/bqanalytic
bigquery firebase-analytics laravel
Last synced: about 1 month ago
JSON representation
Laravel package to use analytic data imported to Big Query from Firebase Analytic
- Host: GitHub
- URL: https://github.com/rezuankassim/bqanalytic
- Owner: rezuankassim
- License: other
- Created: 2020-04-13T10:36:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-02T12:05:15.000Z (almost 2 years ago)
- Last Synced: 2024-09-30T06:21:44.660Z (about 2 months ago)
- Topics: bigquery, firebase-analytics, laravel
- Language: PHP
- Size: 22.1 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: license.md
Awesome Lists containing this project
README
# BQAnalytic
[![Latest Version on Packagist][ico-version]][link-packagist]
This is where your description should go. Take a look at [contributing.md](contributing.md) to see a to do list.
## Installation
Via Composer
``` bash
$ composer require rezuankassim/bqanalytic
```
Optionally you can publish the configuration file
``` bash
$ php artisan vendor:publish RezuanKassim/BQAnalytic/BQAnalyticServiceProvider
```
## Important
In your .env file, make sure you have these value setup
```
GOOGLE_CLOUD_APPLICATION_CREDENTIALS=path_to_your_credentials_file
GOOGLE_CLOUD_PROJECT_ID=your_google_cloud_project_id
BQANALYTIC_BQ_TABLE_NAME=your_bigquery_datasets_name
GOOGLE_CLOUD_APPLICATION_NAME=your_google_cloud_application_name
```
Then
``` bash
$ php artisan migrate
```
After that
``` bash
$ php artisan db:seed --class=AnalyticSeeder
```
If you an error popup when running the command above, you need to publish the vendor file.
## Usage
Include this code into your user entity
``` php
use RezuanKassim\BQAnalytic\Traits\hasAnalyticPreferences;
....
class User extends Authenticatable
{
use Notifiable, hasAnalyticPreferences;
```
Then run ```php artisan bqanalytic:export``` to export big query data into your local database
Note that: ```php artisan bqanalytic:export``` can receive two date which is start date and end date behind it like ```php artisan bqanalytic:export 20200420 20200420```
Next, in your controller
``` php
use RezuanKassim\BQAnalytic\BQAnalytic;
...
$results = (new BQAnalytic(auth()->user(), Carbon::createFromFormat('d/m/Y', $range[0])->format('Ymd'), Carbon::createFromFormat('d/m/Y', $range[1])->format('Ymd')))->getAllAnalytics()[config('bqanalytic.google.accounts')[0]['name']];
```
Optionally you can enable multiple project by
```
BQANALYTIC_MULTIPLE_PROJECTS=true
```
setting this variable in your env and publishing the config file
and insert the code below in ```google => [accounts => [here]] ```
``` php
[
'name' => 'YOUR_PROJECT_NAME',
'google_credential' => "FULL_PATH_TO_YOUR_CREDENTIALS",
'google_project_id' => 'PROJECT_ID',
'google_bq_dataset_name' => 'YOUR_DATASET_NAME'
]
```
By version 1.3, you are able to store all the clients in the database if you wish
```
BQANALYTIC_CLIENT_FROM_DB=true
```
in .env file
This will use an included ``` RezuanKassim\BQAnalytic\BQClient ``` model to store the clients information
Optionally you also can use own model by including
```
BQANALYTIC_CLIENT_MODEL=App\Client
```
in .env file
But remember to include these codes in your client model
``` php
use RezuanKassim\BQAnalytic\Traits\hasClientFromDB;
...
class Client extends Model
{
use hasClientFromDB;
protected $table = 'bq_clients';
protected $guarded = ['created_at', 'updated_at', 'id'];
protected $casts = [
'status' => 'boolean'
];
}
```
## Change log
Please see the [changelog](changelog.md) for more information on what has changed recently.
## Testing
``` bash
$ composer test
```
## Contributing
Please see [contributing.md](contributing.md) for details and a todolist.
## Security
If you discover any security related issues, please email author email instead of using the issue tracker.
## Credits
- [author name][link-author]
- [All Contributors][link-contributors]
## License
license. Please see the [license file](license.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/rezuankassim/bqanalytic.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/rezuankassim/bqanalytic
[link-downloads]: https://packagist.org/packages/rezuankassim/bqanalytic
[link-travis]: https://travis-ci.org/rezuankassim/bqanalytic
[link-styleci]: https://styleci.io/repos/12345678
[link-author]: https://github.com/rezuankassim
[link-contributors]: ../../contributors