Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 1.26 KB

README.md

File metadata and controls

65 lines (45 loc) · 1.26 KB
Raw

URL-shortener: Shrinkly

URL shortening service built with Flask and SQL.

Overview

Shrinkly is a full-stack web application that allows users to convert long URLs to more accessible and maintainable short URLs.

Utilized Flask Rest framework, SQL, and implemented Base62 encoding algorithm for the shortening service.

Live Demo

Find the live version of the app here: Shrinkly.com

Project Structure

├── Procfile
├── README.md
├── .gitignore
├── requirements.txt
├── url_shortener
    ├── static  
    ├── templates
    ├── __init__.py
    ├── extensions.py
    ├── models.py
    ├── routes.py
    ├── settings.py
    └── utils.py

Getting Started

  1. Clone the repo
$ git clone https://github.com/OfiliPatrick/url-shortener
$ cd url-shortener
  1. Initialize and activate a virtualenv:
$ virtualenv --no-site-packages venv
$ source venv/scripts/activate
  1. Install the dependencies:
$ pip install -r requirements.txt
  1. Run the development server:
$ flask run
  1. Navigate to http://localhost:5000

All configuration is in settings.py.