zootedb0t/url_shortner

A simple url-shortner built using flask and bitly api.

URL Shortener App

A url-shortner built using flask and Bitly api. It has following dependencies:

• Flask - Core dependency
• SQLAlchemy - For working with database
• requests - For sending GET and POST request
• PyQRCode - For generating QR code of URL

For using bitly api go to Bitly website and get a free account to get authentication key and group id. Use these credentials in the applications.

To find out guid for your account. Make a GET request to https://api-ssl.bitly.com/v4/groups you can use Postman, Curl, Node or Python request module.

While making request pass your Authorization token to header. In curl you can do this

curl \
-H 'Authorization: Bearer {TOKEN}' \
-X GET \
https://api-ssl.bitly.com/v4/groups

This returns a json object containing guid. For more info

Running App Locally

• Clone the repo:

git clone https://github.com/zootedb0t/url_shortner && cd url_shortner

• Create a python virtual environment:

python -m venv venv

• Activate virtual environment:

source venv/bin/activate

• Install required modules:

pip install -r requirements.txt

• Run app:

flask run

App in action

App home page

Add Api Keys

User database containing urls

Short-URL generated through api

Short-URL QR Code

url_shortner's Issues

Docker image not working

Generate QR code with pyqrcode module

Add search button to search for urls present in database

Add copy to clipboard button in database

Remove deprecated function before_first_request() from flask 2.3

Handle error when internet not available

Handle flash messages

Show flash message to user when copying from database

Increase web-page loading speed

Remove font-awesome icons as they are slow to load

fix links input without https

Don't draw table header if database is empty

Update README

Copy short-url from database not working on server

Fix code scanning alert - Potentially unsafe external link

Tracking issue for:

• https://github.com/zootedb0t/url_shortner/security/code-scanning/1

Make front-end ui responsive

TODO

• Add option to delete api keys from database
• Add check for empty api key
• Center api table

Add download qr-code button

Add animations to footer

Copy to clipboard broken

Url and api key database entries can be delete with GET request

make webpage beautiful

Make shortner webpage beautiful and add copy to clipboard option.