Free, open-source, self-hosted URL shortener web application based on the Laravel PHP Framework.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app rev-181113 Nov 13, 2018
bootstrap rev-180930 Sep 30, 2018
config rev-181113 Nov 13, 2018
database rev-181029 Oct 30, 2018
public rev-181108 Nov 8, 2018
resources rev-181113 Nov 13, 2018
routes rev-181108 Nov 8, 2018
storage rev-180913 Sep 13, 2018
tests Apply fixes from StyleCI Sep 2, 2018
.editorconfig rev-180907 Sep 7, 2018
.env.example Initial commit Aug 6, 2018
.gitattributes Initial commit Aug 6, 2018
.gitignore rev-180920 Sep 20, 2018
LICENSE Initial commit Aug 6, 2018
artisan Initial commit Aug 6, 2018
composer.json rev-181023 Oct 24, 2018
composer.lock rev-181113 Nov 13, 2018
package.json
phpunit.xml rev-181027 Oct 27, 2018
readme.md rev-181029 Oct 30, 2018
server.php
webpack.mix.js rev-180923 Sep 23, 2018
yarn.lock rev-181113 Nov 13, 2018

readme.md

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

screenshot screenshot screenshot screenshot

Requirements

Quick Start

Installation Instructions

  1. Run composer install.

  2. 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.

  3. Run php artisan key:generate.

  4. Run php artisan migrate --seed.

  5. Run php artisan serve.

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

  6. Login

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

Compiling assets with Laravel Mix

Using NPM:

  1. From the projects root folder run npm install
  2. Run npm run dev or npm run prod
  • You can watch assets with npm run watch

Using Yarn:

  1. From the projects root folder run yarn
  2. Run yarn dev or yarn prod
  • You can watch assets with yarn watch

Contributing

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

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

License

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