Shortly

A URL management application built with python django PostgreSQL. Shortly is simlar to Bitly a popular URL management application.

A simple, reponsive website. Built with:

• Python 🐍
• Django 🎸
• Bootstrap 4 🌈
• PostgreSQL
• Redis (for cacheing)
• Vanilla JS - ES6
• JQuery
• ChartJS
• HTML
• CSS

Features

• ability to shorten url as anonymous user from index page
• URL shortening
• ability to customize the shortened URL
• shows analytic data in charts based on clicks on short urls
• QR code generation on shortened URL
• share shortened URL in social medias
• can add Tags to categoriza links
• search functionality
• authentication
• sends email when new user registers to the application
• shows last 7 days total clicks in dashboard

How to run this project (Ubuntu 18.04)

1. Clone the project

git clone https://github.com/Aby-Sebastian/Shortly.git

2. Make sure you are in Shortly folder

3. Install all dependencies

   pip install -r requirements.txt

4. Install PostgreSQL in your Ubuntu 18.04

   1. Enable PostgreSQL Apt Repository

      sudo apt-get install wget ca-certificates
      
      wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
      
      # Now add the repository to your system.
      
      sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt/ `lsb_release -cs`-pgdg main" >> /etc/apt/sources.list.d/pgdg.list'

   2. Install PostgreSQL on Ubuntu

      sudo apt-get update
      sudo apt-get install postgresql postgresql-contrib

   3. Connect to PostgreSQL

      sudo su - postgres
      psql

      Now you are logged in to PostgreSQL database server. To check login info use following command from the database command prompt.

      postgres-# \conninfo

   4. Create a database

      CREATE DATABASE shortly;

   5. Create user

      CREATE USER pks WITH PASSWORD 'abc123!';

5. Run Migrations

python manage.py makemigrations
python manage.py migrate

5. Run Server

python manage.py runserver 

And you are good to go.

To run with SQLite only

Go inside the 'shortly' folder and open 'settings.py' file and replace

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'shortly' ,
        'USER': 'pks',
        'PASSWORD': 'abc123!',
        'HOST':'localhost',
        
    }
}

To:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    }
}

This is the default configuration of Django database.

Backend

For Database I have used Postgres Database Name: shortly

Note: Please change those gmail credentials from real_estate folder you will get settings.py inside that file you will see username and password mentioned as place your Username and Password. Also do that same thing from Contacts folder views.py you will see YourEmail mentioned on line number 33.

Screenshots

• HOME

• Register

• Login

• Dashboard

• Links

• Tags

• Files

• Gallery

• Settings

References

1. https://www.djangoproject.com/