Shortie is a project I created for managing short URLs and tracking. Created with Laravel, Vue, and Inertia.
- Manage your Short URLs, either company-wide or per user.
- Short URL Analytics
- User management with configuration around allowing new users / default roles.
- Domain management for self-managed domains.
- PHP 8.2 / PHP 8.3
- MySQL / Postgre / SQLite
- Node v16: For rebuilding assets (optional)
First download the project to where you intend to host it from.
via HTTPS:
$ git clone https://github.com/Harrk/Shortie.git
or via SSH:
$ git clone [email protected]:Harrk/Shortie.git
Install dependencies.
$ composer install --no-dev
Configure your .env
file with your database credentials.
$ php artisan migrate
Optional: Assets are prebuilt, but you can rebuild them with the following:
$ yarn && yarn build
Create yourself an admin user.
$ php artisan app:create-admin
Navigate to the location you're hosting the project from to verify it's all set up.
Before creating a short URL, you must set up a domain. You will need to do this even if you only intend to use a single domain.
Please review the CONTRIBUTING.md document before making any contributions to the project.