UrlHub

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

Requirements

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

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@urlhub.test	admin	admin	Admin Access
   user@urlhub.test	user	user	User Access

Compiling assets with Laravel Mix

Using NPM:

1. npm install

2. npm run dev or npm run prod

   You can watch assets with npm run watch

Using Yarn:

1. yarn

2. yarn dev or yarn prod

   You can watch assets with yarn 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!

Running Tests

On .env file, set DB_TEST_ with the settings used behind.

From the projects root folder run ./vendor/bin/phpunit

License

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