PhpDev.App
gallib/laravel-short-url

gallib/laravel-short-url

Stars: 161

Forks: 39

Pull Requests: 22

Issues: 8

Watchers: 6

Last Updated: 2023-02-01 23:44:11

A Laravel package to shorten urls

License: MIT License

Languages: PHP, Blade

Laravel Short URL logo

Laravel Short Url Build Status StyleCI

Laravel Short Url is a package allowing you to shorten urls.

Installation

With composer

composer require gallib/laravel-short-url

then run

php artisan vendor:publish --provider="Gallib\ShortUrl\ShortUrlServiceProvider"
php artisan migrate

finally, paste ShortUrl::routes(); at the end of routes/web.php

Configuration

Laravel Short Url configuration file can be found on config/shorturl.php

  • blacklist : Allows to blacklist urls. Keywords can be either an url, a keyword or an extension

Advanced configuration

Instead of adding ShortUrl::routes(); you can call three separates methods:

  • ShortUrl::createRoutes(); to shorten urls
  • ShortUrl::manageRoutes(); to manage urls
  • ShortUrl::redirectRoute(); to redirect to the url

this allows you to add middlewares or prefix routes.

Migration Customization

If you are not going to use Short Url's default migrations, you should call the ShortUrl::ignoreMigrations(); method in the register method of your AppServiceProvider. You may export the default migrations using

php artisan vendor:publish --tag=shorturl-migrations

Nice!

Laravel short url is now set up on your homepage.

Credits