Plur

Warning: This software is still in development, so we don’t recommend you run it on a production site.

Plur is a free, open-source and easy-to-use but powerful URL shortener. It allows you to host your own URL shortener, and gives you many useful features.

Features

URL Shortener.
Customized short URL's(ex: example.com/laravel).
QR code generator for each short link.
Sortable list of shortened URLs.
Written in PHP and Laravel 5.7.
Datatables with server-side processing.
Modern and simple interface.
Made with ❤️ & ☕.

Screenshots

Requirements

All requirements by Laravel - PHP >= 7.1.3, Composer and such.
MySQL or MariaDB.

Quick Start

Installation Instructions

Run composer install.
Rename .env.example file to .env or run cp .env.example .env.

Update .env to your specific needs. Don't forget to set DB_USERNAME and DB_PASSWORD with the settings used behind.
Run php artisan key:generate.
Run php artisan migrate --seed.
Run php artisan serve.

After installed, you can access http://localhost:8000 in your browser.
Login

Email Username Password Access

admin@plur.test admin admin Admin Access

user@plur.test user user User Access

Email	Username	Password	Access
admin@plur.test	admin	admin	Admin Access
user@plur.test	user	user	User Access

Compiling assets with Laravel Mix

Using Yarn:

From the projects root folder run yarn
Run yarn dev or yarn prod

You can watch assets with yarn watch

Using NPM:

From the projects root folder run npm install
Run npm run dev or npm run prod

You can watch assets with npm run watch

Contributing

Any useful suggestion and PR are welcomed. If you would like to contribute, please do the following:

Fork the repository.
Hack on a separate topic branch created from the latest master.
Commit and push the topic branch.
Make a pull request.
Welcome to the club 😎 and thank you for helping out!

License

Plur is an open-sourced software licensed under the MIT license.

jigarhalani/plur