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.
- 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 ❤️ & ☕.
- All requirements by Laravel - PHP >= 7.2, Composer and such.
- MySQL or MariaDB.
-
Run
composer install
. -
Rename
.env.example
file to.env
or runcp .env.example .env
.Update
.env
to your specific needs. Don't forget to setDB_USERNAME
andDB_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 [email protected] admin admin Admin Access [email protected] user user User Access
- From the projects root folder run
yarn
- Run
yarn dev
oryarn prod
- You can watch assets with
yarn watch
- From the projects root folder run
npm install
- Run
npm run dev
ornpm 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:
- 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!
UrlHub is an open-source software licensed under the MIT license.