Skip to content

liamondo/shorten

Repository files navigation

Build Status Lastest Release Demo

About Shortening

Shorten is URL shortener built with Laravel PHP and Laravel Livewire.

Features

  • Light and dark themes (auto selected by browser preference)
  • Shorten link to link with short base62 code
  • Avoid duplicate links by returning existing short link when duplicate original links are requested
  • Track stats for links such as: number of times short link requested and number of times short link followed
  • Unit tests, feature tests, and continuous interaction tests

Screenshots

Requirements

  • PHP 7.4 or higher
  • Composer
  • NPM
  • Database (MySQL, PostgreSQL, etc)

Installation

  1. Close the GitHub repository
git clone https://github.com/liamondo/shorten.git
  1. Copy .env.example to .env

  2. Install dependencies and compile

composer install
npm install
npm run dev
  1. Migrate the database
php artisan migrate

To view the project you can run php artisan serve or use a local web server.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT