fabinhojorge / urlshortener

The idea of this project is to study while developing an URL shortener tool. Main technology is Django and Bootstrap 4

URL Shortener

The idea of this project is to study some technologies and practice. Here you will find a URL shortener like bit.ly.

How to install and Run

After activate your Python Virtual Environment (venv) run the below command:

pip install -r requirements.txt

python manage.py migrate

python manage.py runserver

So you can access in the local URL: localhost:8000

How to use

1. In the home page you can find an input text. Type the URL there and press Enter/Submit button
2. It will generate a short URL.
3. If you click in the short URL you will be redirect to the original URL
4. To get the statistics you just add a plus (+) signal in the end of the URL, example:
   • URL: localhost:8000/2A14S6REML
   • Statistic URL: localhost:8000//2A14S6REML+

Obs: Replace the localhost:8000 by your domain

Libraries

• Django
• Django Rest Framework
• Bootstrap
• JQuery

To Do

• Enhance the logic for redirect URL. It´s not working for all the URLs
• Add the continuous integration build and test (Circleci)
• Add test cases for BE
• Add test cases for FE

Screen Shots

Home Page

Statistic Page

Redirect Functionality