https://github.com/mniknab/surl
SURL - Laravel Short Url
https://github.com/mniknab/surl
laravel laravel-package short-url shortener surl url url-shortener
Last synced: about 1 month ago
JSON representation
SURL - Laravel Short Url
- Host: GitHub
- URL: https://github.com/mniknab/surl
- Owner: mniknab
- License: mit
- Created: 2020-03-09T14:11:41.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-03-10T19:40:51.000Z (about 5 years ago)
- Last Synced: 2025-03-26T13:54:00.182Z (about 2 months ago)
- Topics: laravel, laravel-package, short-url, shortener, surl, url, url-shortener
- Language: PHP
- Size: 32.2 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## About Surl
**SURL** is a package allowing you to shorten urls.
*By [Mohammad Niknab](https://github.com/mniknab)*
## 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:
```php
'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`