URL Shortener App

A Django URL Shortener App created with Django 3.0 and Python 3.8 to shorten any URL given. This project is made to learn Django.

Live Site running on Heroku: https://myurlshortener1.herokuapp.com/

Demostration

How to Setup in Localhost

Clone this repository.
Open the cloned repository.
Install dependencies using pip install -r requirements.txt OR Install pipenv using pip install pipenv and initialise a Virtual Machine using pipenv install in the directory.
Set environment variables like SECRET_KEY, DEBUG_VALUE.
Run the Django Server using python manage.py runserver and then goto localhost:8000 or 127.0.0.1:8000 and see the server running.

Environment Variables:

SECRET_KEY: Django secret key which can be any long hexadecimal value. Django recommends atleast 50 characters to make it secure. DEBUG_VALUE: Set it as "True" for Debug environment and "False" for Production.

How to Setup for Production

Refer on how to deploy Python apps in Heroku here and Django app configuration here.

Features

Can shorten any url.
Can see all the shortened urls created with it.
Can choose any custom value to shorten the url.

Features to add

Improve the CSS of the site.
Add a User Authentication system.
Add a process to delete any redirects not used within 7 days.

More features can be suggested in Issues.

Known Issues:

No issues detected till now.

Please make a GitHub issue if any other bugs are found.

Notes

This project was created on Ubuntu-20.04 LTS and tested under Windows 10 and Ubuntu, and is expected to work fully in other systems too.

This project is still under development. Parts of the source codes may not be well documented. Also suitable prompts may not be available for the user at the moment.

More features and fixes are yet to come. Meanwhile suggestions, ideas, bug reports are welcomed.

Harsh-2909/Url-Shortener