Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 1.86 KB

README.md

File metadata and controls

70 lines (47 loc) · 1.86 KB
Raw

Shrynk

Built with ❤︎

Shrynk - A simple implementation of a URL shortener similar to bit.ly, tiny.url, etc. Users can create and manage multiple URLs. The application provides a short url, which can be used to access the desired website.

Features of Shrynk

Version 1.0

  1. User can login to his/her account
  2. Users can generate multiple short URLs.
  3. Once the user logs in, he/she could see the list of short URLs the user has generated.

Technology Stack

  • Python 3.6.5 and above.
  • Other python library dependencies specified in the requirements.txt

Instructions to use this Software

  1. Change directory to project root /Shrynk

  2. Python Virtual Enviornment

    2.1. Create Python Virtual Enviornment by virtualenv "env name" here we have used "Swizzl" as the name of the virtual enviornment. So, type virtualenv Shrynk.

    2.2. Activate the virtual enviornment by source "env name"/bin/activate which is source Shrynk/bin/activate here.

  3. Start the Application

       python run.py

    or

       export FLASK_APP=run.py
   flask run

  4. Log-in or Register in the application

  5. Click AddURL to shorten url.

  6. Click Dashboard to view all shortened urls and other info*.

Screenshots

Intro Page

intro

Login Page

login

Dashboard

dash

Note: This is a rudimentary implementation of a url shrinking API. No sys-design concepts/factors were considered while making.