Skip to content

RH203/shortbae

Repository files navigation

πŸš€ Shortbae β€” Simple URL Shortener

Shortbae is a clean and simple URL shortener built with Laravel 11, Livewire, and Tailwind CSS.
It's completely free, with no ads, no tracking, and designed for easy deployment even on shared hosting (cPanel).

πŸ§ͺ Upcoming Features

  • πŸ”‘ Password-protected short links
  • πŸ“Ž QR Code generation
  • πŸ“ˆ Link analytics and stats

🌟 Features

  • πŸ” User authentication (Spatie Roles & Permissions)
  • πŸ”— Custom and auto-generated short URLs
  • ⏳ Optional expiration dates for each link
  • πŸ“Š Basic analytics: visit count
  • βš™οΈ Deployed using Laravel traditional public folder setup (not Vite-based)

πŸš€ Getting Started

πŸ”„ Clone the repository:

git clone https://github.com/rh203/shortbae.git
cd shortbae

🌿 Switch to development branch:

git checkout dev

πŸ’‘ You can explore other branches using:

git branch -a

πŸ› οΈ Requirements

  • PHP >= 8.2
  • Composer
  • MySQL / MariaDB
  • Node.js (if running Vite locally)
  • Laravel CLI

βš™οΈ Setup Instructions

composer install
cp .env.example .env
php artisan key:generate
php artisan migrate
php artisan db:seed
php artisan serve

πŸ“ Contribution Rules

If you'd like to contribute, please follow these rules:

  • πŸ”„ Create a feature branch:
git checkout -b feature/your-feature-name
  • πŸ” Avoid pushing directly to main branch
  • πŸ“¦ Use clear commit messages

πŸ“¬ Contact

Feel free to open an issue or discussion if you want to contribute or report a bug.

About

πŸš€ Simple and clean URL shortener built with Laravel, Livewire, and Tailwind CSS. Free to use, no ads, no tracking.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages