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

Whatever your idea, feel free to send a pull request 😃

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.

• 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 7.
• Datatables with server-side processing.
• Modern and simple interface.
• Made with ❤️ & ☕.

• All requirements by Laravel & PHPUnit 9 - PHP >= 7.3, Composer and such.
• MySQL or MariaDB.

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

1. yarn

2. yarn dev or yarn prod

   You can watch assets with yarn watch

1. npm install

2. npm run dev or npm run prod

   You can watch assets with npm run watch

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!

From the projects root folder run ./vendor/bin/phpunit (VSCode Task Run test) or Artisan Test Runner php artisan test

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