mniknab/surl

SURL - Laravel Short Url

1.1.0 2020-03-10 19:35 UTC

Requires

• php: >=7.2.0
• ext-json: *

Requires (Dev)

• codedungeon/phpunit-result-printer: dev-master
• orchestra/testbench: ^5.0
• php-coveralls/php-coveralls: ^2.2
• phpunit/phpunit: ^8.0|^9.0

MIT

• Mohammad Niknab

• url
• short url
• Shorturl
• short
• short-url
• surl

README

About Surl

SURL is a package allowing you to shorten urls.

By Mohammad Niknab

Installation

Composer

You can install this package via Composer by running this command:

composer require mniknab/surl

Laravel

Setup

NOTE : The package will automatically register itself if you're using Laravel >= v5.5, so you can skip this section.

Once the package is installed, you can register the service provider in config/app.php in the providers array:

'providers' => [
    ...
    Mniknab\Surl\SurlServiceProvider::class,
],

Artisan commands

To publish the config, migrations and views files, run this command:

To force publishing add --force flag.

php artisan vendor:publish --provider="Mniknab\Surl\SurlServiceProvider"

To create the tables, run this command:

php artisan migrate

Configuration

Surl configuration file can be found on config/surl.php

Usage

NOTE: You can also use Surl as an API.

Go to http://{your-project}/surl-management