URL Shortener made using Django
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
shortener
static
staticfiles
urlShortener
.travis.yml
LICENSE
README.md
db.sqlite3
manage.py
requirements.txt

README.md

URL-Shortener Build Status

A simple and easy to use web app built using Django. Simply give the url you want reduced and get the new shortened url based on base62 encoding.

Wanna try this app? Visit: http://shly.pythonanywhere.com/

I developed this app after watching this video by Tushar Roy about tiny url. I wanted my own solution and was also interested in particle.js hence this project was born.

Features:

  • Url shortening using Base62 encoding. (a-zA-Z0-9)
  • REST API for retrieving data easily.
  • Beautiful background using particles.js
  • Fully responsive. use any device and always find the best layout.

Working

Each url has a unique id in the database. We use this id and encode it using Base62 encoding. This encoded string is stored as the short url for the original url.

def b62_encode(number):
    base = string.digits+string.ascii_letters
    assert number >= 0, 'positive integer required'
    if number == 0:
        return '0'
    base62 = []
    while number != 0:
        number, i = divmod(number, 62)
        base62.append(base[i])
    return ''.join(reversed(base62))

How to run the project locally

Download the zip or Clone this repository: git clone https://github.com/shubhamnishad97/URL-Shortener.git

Install the dependencies by simply executing: pip install -r requirements.txt

Run this command to start the app: python manage.py runserver

Visit 127.0.0.1:8000 on your web browser and don't forget to give me some feedback.

How to access the api

to shorten url, send POST request to: http://yourdomain.com/api/<url to be shortened>/

to retrieve url, send GET request to: http://yourdomain/api/<shortcode>/

you can test api on: http://shly.pythonanywhere.com/api/

Todo

  • making a REST api for this project.
  • suggestions are welcome

License MIT