URL Shortener

A simple URL Shortener application with Laravel.

Installation

It's a Laravel 8.17.2 application with a very little functionality. You can install it as any other laravel 8 application. Here are the commands you need to run one by one-

git clone git@github.com:milon/url-shortener.git url
cd url
composer install
npm install
npm run dev
cp .env.example .env
php artisan key:generate

Then you need to put your database credentials in the .env file. I used MySQL in this project, but any Eloquent supported relational database can be used. After that run these-

php artisan migrate

Then to run the development server, run this-

php artisan serve

Then you can visit the url shortener in this url- http://127.0.0.1:8000.

You should also give write permission to the storage folder

Uses

This application can be used both in logged in or logged out state. But for using the full potential, you should logged in.

This project has following features-

Full fledged registration and login system
Proper validation for each form
Option for private url
Basic statistics
Basic Admin Panel

screenshots

Demo

Demo application can be found on heroku.

Admin User

There is no way to create an admin user from the UI. You need change the value of is_admin in the users table directly from database to gain admin access.

You can also run php artisan db:seed to create an admin user with the following credentials-

Name	Value
Name	Admin User
Email	admin@url.com
Password	password

CLI Command

There is also two cli command for ease of use. One for shortening the URL and another for resolve a shortened URL. You can get the usage form this command-

php artisan url:short --help
php artisan url:resolve --help

API

This project comes with 2 basic API endpoints to create and retrieve shorten links. Standard token based authentication is used here. Token can be generated and obtained from settings menu. A postman collection can be downloaded for the demonstration.

`GET /api/links/{hash}`

Request

curl -i -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer vzjxb8palszAMKXDtZg4rn5lapZe4m" localhost:8000/api/links/AKKJ5g

Response

{
    "error": false,
    "link": {
        "created_at": "07-11-2019 09:03",
        "hash": "AKKJ5g",
        "is_private": false,
        "url": "https://laravel.com/docs/6.x/eloquent-mutators#attribute-casting",
        "user": null
    }
}

`POST /api/links`

Request

curl -X POST -d '{"url":"https://laravel.com/docs/6.x/validation","is_private":0,"allowed_email":"contact@milon.im, test@gmail.de"}' -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer vzjxb8palszAMKXDtZg4rn5lapZe4m" localhost:8000/api/links

Response

{
    "error": false,
    "link": {
        "url": "https://laravel.com/docs/6.x/validation",
        "hash": "0HPOTS",
        "is_private": true,
        "allowed_email": [
            "contact@milon.im",
            "test@gmail.de"
        ],
        "created_at": "08-11-2019 13:12",
        "user": {
            "name": "Milon",
            "email": "contact@milon.im",
            "created_at": "07-11-2019 09:04"
        }
    }
}

Testing

Unit Test

Make sure you have your database config setup on .env.testing file. I used sqlite3 database for testing. Create a database.sqlite file in the database directly and then run the following command to run test-

./vendor/bin/phpunit

Browser Test

I used Laravel Dusk for browser test. To install it's dependencies run the following command-

php artisan dusk:install

Make sure you start your server and add the homepage URL in APP_URL config in .env.testing file. Then run the following command-

php artisan dusk

Developer

Nuruzzaman Milon
contact@milon.im
https://milon.im

rhidoyhasanmahmud / url-shortener