This package makes it easy to add early access mode to your existing application.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
database/migrations
public
resources
routes
src Fixed bug with package publisher Jan 6, 2019
tests
.gitignore
.scrutinizer.yml
.styleci.yml
.travis.yml
changelog.md
composer.json
contributing.md
license.md
mix-manifest.json
package.json
phpunit.xml.dist
readme.md
tailwind.js
webpack.mix.js

readme.md

This package makes it easy to add early access mode to your existing application. This is useful for when you want to launch a product and need to gather the email addresses of people who want early access to the application.

Take a look at contributing.md to see a to do list.

Installation

Via Composer

To install via composer, run the following command in the root of your Laravel application:

$ composer require neo/laravel-early-access

If you are on Laravel 5.4 or below, register the Neo\EarlyAccess\EarlyAccessServiceProvider service provider in the config/app.php file.

<?php

return [

    // [...]

    'providers' => [

        // [...]

        /*
         * Package Service Providers...
         */
        Neo\EarlyAccess\EarlyAccessServiceProvider::class,

        /*
         * Application Service Providers...
         */

        // [...]
    ],
];

If you are on a Laravel version greater than 5.4, it will be registered automatically by Laravel.

Register the middleware Neo\EarlyAccess\Http\Middleware\CheckForEarlyAccessMode at the bottom of your web group middleware in app/Http/Middleware/Kernel.php.

<?php
// [...]

'web' => [
    \App\Http\Middleware\EncryptCookies::class,

    // [...]

    \Neo\EarlyAccess\Http\Middleware\CheckForEarlyAccessMode::class,
],

// [...]

Next, add/update the MAIL_* keys in your .env file. Make sure to include MAIL_FROM_* keys as it is required when sending welcome or goodbye emails to subscribers.

Also you can optionally add the following environment variables to your .env file:

EARLY_ACCESS_ENABLED=true
EARLY_ACCESS_URL="/early-access"
EARLY_ACCESS_LOGIN_URL="/login"
EARLY_ACCESS_TWITTER_HANDLE=NeoIghodaro
EARLY_ACCESS_VIEW="early-access::index"
EARLY_ACCESS_SERVICE_DRIVER=database
EARLY_ACCESS_SERVICE_DB_TABLE=subscribers

Now run the following command to migrate the required tables:

$ php artisan migrate

Next, publish the packages assets:

$ php artisan vendor:publish --provider="Neo\EarlyAccess\EarlyAccessServiceProvider"

This will make the config, migrations, views, and assets available inside your applications directory so you can customise them.

TIP: You can append the --tag=assets flag to publish only the asset files which is required. Other available tag values are: config, translations, migrations, views and assets.

To activate early access, you can do either of the following:

  • Run the command $ php artisan early-access --activate (Recommended)
  • Set the EARLY_ACCESS_ENABLED to true in your .env file

TIP: Using the artisan command allows you to add IP addresses that are allowed to bypass the early access screen altogether.

$ php artisan early-access --allow=127.0.0.1 --allow=0.0.0.0

Also note that logged in users will bypass the early access screen also.

Configuration

Now that you have installed it successfully, you can start configuring it. First, publish the configuration file to your application if you have not already done so.

$ php artisan vendor:publish --provider="Neo\EarlyAccess\EarlyAccessServiceProvider" --tag=config

Configuration options

  • enabled - Sets whether the mode is enabled or not. In terms of priority, this is the last thing that is checked to see if the early access screen should be shown. Login status is checked, then artisan command status is checked, then this value is checked. default: false

  • url - The URL the early access screen will be shown at. The client will be redirected to this URL if they do not have access and the mode is enabled. You can set the value to / or any other existing routes. default: /early-access

  • login_url - The URL to your application's login page. This URL will automatically be bypassed even if early access mode is turned on. default: /login

  • twitter_handle - This is used when sending subscription confirmation via email.

  • view - The early access screen view to be loaded. You can publish the views and customise it, or leave the default. default: early-access::index.

  • service - This is the subscription driver. See below for how to create your own driver. default: database.

  • services.database.table_name - The database table name. This is useful is you want to change the name of the database table. You need to do this before you run the migration though. default: subscribers

  • notifications - The default notification classes. You can use your own notification classes if you would like to change how users are notified when they subscribe or unsubscribe.

Using / or an existing route as the early access URL

To use / or an existing route in your application as the early acces URL, you need to do the following:

First, register the service provider manually below the App\Providers\RouteServiceProvider::class in config/app.php.

<?php

return [

    'providers' => [

        // [...]

        App\Providers\RouteServiceProvider::class,
        Neo\EarlyAccess\EarlyAccessServiceProvider::class,

        // [...]

    ],

    // [...]
];

Next, open your composer.json file and add the package in the dont-discover array:

// [...]

"laravel": {
        "dont-discover": [
        "neo/laravel-early-access"
    ]
},

// [...]

Now run composer dump-autoload -o and it should work.

Creating your own subscription service driver

By default, there is a database driver that manages all the users. You can decide to create your own driver though for other services like Mailchimp etc. (If you do, please consider submitting a PR with the driver).

To get started, you need to create a new class that implements the service provider class:

<?php

namespace App\Services\SubscriptionServices;

use Neo\EarlyAccess\Contracts\Subscription\SubscriptionProvider;

class MailchimpService implements SubscriptionProvider
{
    public function add(string $email, string $name = null): bool
    {
        // Implement adding a new subscriber...
    }

    public function remove(string $email): bool
    {
        // Implement removing a subscriber...
    }

    public function verify(string $email): bool
    {
        // Implement verifying a subscriber
    }

    /**
     * @return \Neo\EarlyAccess\Subscriber|false
     */
    public function findByEmail(string $email)
    {
        // Implement returning a subscriber from email
    }
}

Next, register your service in the register method of your app/Providers/AppServiceProvider class:

<?php

// [...]

$this->app->bind('early-access.mailchimp', function () {
    return new \App\Services\SubscriptionServices\MailchimpService;
});

// [...]

NOTE: Leave the early-access. namespace. It is required. Just append the name of your service to the namespace as seen above.

Next, go to your published configuration and change the service driver from database to mailchimp. That's all.

Change log

Please see the changelog for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see 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

License

Please see the license file for more information.