aditeyabaral / redirector

A simple link redirecting service built using Flask

redirector

Redirector is a simple link redirecting service. Built using Flask and SQLAlchemy, it aims to provide a way to shorten and redirect links but usually fails at the former.

How to use Redirector?

Creating redirecting links

Since I'm awful at making pretty interfaces, creation of redirection links can currently only take place using POST requests.

Use the following Python script to make a POST request and create your link.

import sys
import requests

params = {
    "source_url" = sys.argv[1],
    "alias_url" = sys.argv[2]
}

response = requests.post("https://goto-link.herokuapp.com/register", data=params)
print(str(response.content))

Execute the above script using

python3 source_url alias_url

Example, use

python3 https://github.com/ git

Accessing redirecting links

You can access an alias link using goto-link/alias_name

Why use Redirector?

• Open Source

Yup, that's the only advantage I can think of.

Why not to use Redirector?

• The alias links may not be always shorter because of the size of the link prefix
• Creation of alias links is tedious (for now)

It is not as bad as it sounds though.

How to contribute to Redirector?

A pretty interface to create alias links would be a good starting point.

Why did I make a link redirecting service?

Honestly, even I do not know why this exists.

redirector's Issues

GUI

A simple, clean and easy to use GUI would be neat to host the link creation pages.

1. The page should contain 2 text boxes, one for the source URL and the other for the alias name.
2. After clicking on a submit button, it should display the complete URL, as well as options to copy link and open the link in a new tab
3. Additionally, it should also be copied to clipboard

Add functionality to update and delete added links

Users can be identified using the IP address used to create the redirected link. Create endpoints to allow users to modify their links.

Create random string for alias URL if it is not passed in JSON

As the topic suggests, if the alias URL has not been specified, generate a 6-letter random string (uppercase, lowercase and numbers) for the alias URL

Fetch all alias links for a given source URL

Create a separate app route that fetches all the alias links that have been created for a particular source URL. This will allow users to use pre-existing links that already exist.

Fetch all links for a given user

Identify all the links created by a user's IP and return them

Dockerise the project using `docker-compose`

Dockerise the project using docker-compose. Allows the entire application to be quickly deployed and built as well. Ensure the database and everything else is setup at boot time.