Skip to content

arregnault/url-shortener

Repository files navigation

URL Shortener

URL shortener developed with Laravel framework.

Table of Contents

General Information

This project provides an API to generate short URLs and redirect them to the original links.

It was developed as a practice.

Technologies Used

Features

  • Generate shortened URLs for quick use.

Setup

Clone the project:

git clone https://github.com/arregnault/url-shortener.git

Install Laravel dependencies:

cd url-shortener
composer install

Generate key:

php artisan key:generate

Run migrations:

php artisan migrate --seed

Create testing database:

touch database/testing.sqlite

Usage

Run tests:

php artisan migrate --env=testing && ./vendor/bin/phpunit --testsuite Unit

Run tests coverage:

php artisan migrate --env=testing && ./vendor/bin/phpunit --testsuite Unit --coverage-html coverage/

Web access to documentation

http://127.0.0.1:8000/api/documentation

Project Status

Project is: in progress.

Room for Improvement

TODOs for future development.

To do:

  • Visitors log.
  • User authentication.
  • Management of links owned by users.