Skip to content
forked from realodix/urlhub

URL shortener web application based on the Laravel PHP Framework.

License

Notifications You must be signed in to change notification settings

martinsv/urlhub

 
 

Repository files navigation

UrlHub

MadeWithLaravel.com shield LaravelVersion PHPVersion GitHub license StyleCI shield

Warning: UrlHub is under heavy development and isn't still stable enough to be used in production environments. We could change and / or remove functions in any moment.

UrlHub was created, and is maintained by Budi Hermawan, and is an open-source, 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.8.
  • 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
    [email protected] admin admin Admin Access
    [email protected] user user User Access

Compiling assets with Laravel Mix

Using Yarn:

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

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

Contributing

Thank you for considering contributing to UrlHub. Any useful suggestion and pull requests are welcomed.

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

UrlHub is an open-source software licensed under the MIT license.

About

URL shortener web application based on the Laravel PHP Framework.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 84.1%
  • HTML 15.9%