README

Requirements
Installation
Configuration
Usage
Extras

Requirements

SQLite
Redis Server for cache (File will work too, but not recommended)

Installation

You can install the package via composer:

composer require hulkapps/appmanager

composer dump-autoload

Configuration

1.Initialize App Manager Config

php artisan vendor:publish --provider="HulkApps\AppManager\AppManagerServiceProvider"

In the case that config/app-manager.php is already present, delete it and then run the command below.

Don't forget to update secret on file config/app-manager.php

2.Initialize App Features

According to the example in the file, list all features of the app in config/plan-features.php.

Ensure you use the UIID from this sheet, and don't forget to mention the app name after using the UUID

3.Initialize Fail-safe Database

Initialize MYSQL Fail-safe database in config/database.php

'app-manager-failsafe' => [
			'driver' => 'mysql',
			'host' => env('FAILSAFE_DB_HOST', '127.0.0.1'),
			'port' => env('FAILSAFE_DB_PORT', '3306'),
			'database' => env('FAILSAFE_DB_DATABASE', 'forge'),
			'username' => env('FAILSAFE_DB_USERNAME', 'forge'),
			'password' => env('FAILSAFE_DB_PASSWORD', ''),
			'unix_socket' => env('FAILSAFE_DB_SOCKET', ''),
			'charset' => 'utf8mb4',
			'collation' => 'utf8mb4_unicode_ci',
			'prefix' => '',
			'prefix_indexes' => true,
			'strict' => false,
			'engine' => null,
			'options' => extension_loaded('pdo_mysql') ? array_filter([
				PDO::MYSQL_ATTR_SSL_CA => env('MYSQL_ATTR_SSL_CA'),
			]) : [],
		];

4.Listen Plan Activation Event

Listen and Register plan activation event in app/Providers/EventServiceProvider.

use HulkApps\AppManager\app\Events\PlanActivated;

class EventServiceProvider extends ServiceProvider {
    protected $listen = [
		PlanActivated::class => [
			PlanActivatedListener::class,
		],
	];
}

Usage

Plan and feature helper functions are provided in this package.

Bind trait with user model

use HulkApps\AppManager\app\Traits\HasPlan;

class User extends Model
{
	use HasPlan;
}

Helper functions

$user->hasPlan(); // If the user has plan or not

$user->planFeatures(); // Return the active plan's features with value

$user->hasFeature($featureSlug); // Return the user has given the feature or not

$user->getFeature($featureSlug); // Return data for a feature

$user->getRemainingDays(); // Calculate the remaining days of the active plan

$user->getPlanData(); // Return plan details

$user->getChargeData(); // Return active and recent cancelled charge

$user->setDefaultPlan($plan_id); // Set default plan_id( plan_id Optional)

Extras

Set Shopify API version to 2022-04.

Store plan's total trial Days in shop table (Optional)

Set total_trial_days field name in config/app-manager.php

'total_trial_days' => env('TOTAL_TRIAL_DAYS', 'toal_trial_days'),

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email divyank@hulkapps.com instead of using the issue tracker.

Credits

License

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

hulkapps / appmanager

Maintainers

Details