laravel-short-url - GitLite

KO | EN

gitlite — search

#hacktoberfest #llm #golang #android #machine-learning #rust #deep-learning #linux #macos #nodejs #windows #awesome #vue #pytorch

laravel-short-url

(★ 164)

A Laravel package to shorten urls

File Explorer

Download Latest Version (.zip)

- - logo.png
  - short.png
- shorturl.php
- - 2018_02_13_204645_create_urls_table.php
  - 2018_03_22_160425_add_counter_to_urls.php
  - 2018_04_23_160425_add_title_and_description_to_urls.php
  - 2019_09_06_231356_add_expires_at_to_urls.php
  - 2020_03_04_214540_add_user_id_to_urls.php
- - layout.blade.php
- - Hasher.php
  - ShortUrl.php
- - UrlParser.php
- - Blacklist.php
- Hasher.php
- ShortUrl.php
- ShortUrlServiceProvider.php
- Url.php
- - User.php
- DeleteUrlTest.php
- HasherTest.php
- ParserTest.php
- RedirectTest.php
- TestCase.php
- UpdateUrlTest.php
- UrlTest.php
.gitignore
.travis.yml
composer.json
LICENSE
phpunit.xml
README.md

# Installation Guide

1. Get the code

git clone https://github.com/gallib/laravel-short-url

Downloads the entire project code from GitHub to your computer.

cd laravel-short-url

Moves into the project folder you just downloaded.

2. PHP (Composer)

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

composer require gallib/laravel-short-url

Type this command into your terminal and run it.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
    <img width="80%" src="https://raw.githubusercontent.com/gallib/laravel-short-url/master/assets/images/logo.png" alt="Laravel Short URL logo" />
</p>

# Laravel Short Url [![Build Status](https://travis-ci.org/gallib/laravel-short-url.svg?branch=master)](https://travis-ci.org/gallib/laravel-short-url) [![StyleCI](https://styleci.io/repos/122629531/shield?branch=master)](https://styleci.io/repos/122629531)

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
- Created by [Alain](https://twitter.com/gallib_net)
- Logo by [Caneco](https://twitter.com/caneco)