gitstercode / url-shortener

url-shortener

This service can generate the shortened url for a supplied long-url and can return long-url for the supplied shortened url.

Tech Stack

• This service utilizes an external service called Bitly
• Bitly is used to shorten an url or look up a short-url and find the long-url.
• This API service is built using:
  • Python3
  • Flask
  • PyShorteners

Installation Instructions

This service uses pipenv to install dependencies. Below are the instructions:

# Clone the repo
git clone [email protected]:gitstercode/url-shortener.git
cd url-shortener

# Install dependencies
pipenv install
pipenv shell

# Run the service
python3 shoretner.py

Note: If pipenv doesn't exist, then install it with pip thats compiled with python3

pip3 install pipenv

API Documentation

• /shortify - Takes the long-url and returns the short-url

    curl -X GET http://localhost:<port>/shortify?url=<long url>
  

• /longify - Takes the short-url and returns the original long-url

    curl -X GET http://localhost:<port>/longify?url=<shortened url>
  

• / - Returns the site-map

    curl -X GET http://localhost:<port>/
  

Files:

• Pipfile - Dependencies listed
• Pipfile.lock - Auto-Generated by pipenv
• shortener.py - Application entrypoint