harrk/shortie

A self-hosted Short URL application.

Shortie.

Shortie is a project I created for managing short URLs and tracking. Created with Laravel, Vue, and Inertia.

Features

• 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.

Requirements

• PHP 8.2 / PHP 8.3
• MySQL / Postgre / SQLite
• Node v16: For rebuilding assets (optional)

Installation

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.

Setting 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.

Contributing

Please review the CONTRIBUTING.md document before making any contributions to the project.

shortie's Issues

Build assets included in repository

Due to trying to reduce friction in getting up and running: built assets are stored in source control.
To remove these it's asking the user to build them as part of the setup process, including installing a specific version of Node.

Options:

• Remove the files from source control and let the user deal with it?
• Create a release artifact?