Skip to content

angeldollface/shortly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SHORTLY ⛓️ 🌎

A small Django-powered app to shorten long-ass URLs. 🎀 📜

ABOUT 📚

Since sending links around the WWW has become something of a ubiquitous activity, I thought I'd write a small Django-powered app in Python that makes this easy and fun.

USAGE

Requirements

make sure you have the following tools installed and available from the command line:

Steps

To run this app on your own machine, execute these steps:

  • 1.) Get the source code:
git clone https://github.com/angeldollface/shortly
  • 2.) Install virtualenv:
python3 -m pip install virtualenv
  • 3.) Change directory into Blogly's root:
cd shortly
  • 4.) Create a new virtual environment here:
python3 -m venv .
  • 5.) Activate the virtual environment (The command below is for *nix systems. Do the equivalent for this on Windows.):
source bin/activate
  • 6.) Install the project's dependencies:
python -m pip install -r requirements.txt
  • 7.) Setup the database migrations:
python manage.py migrate
  • 8.) Run the migrations for the links app:
python manage.py makemigrations links
  • 9.) Rerun the migrations:
python manage.py migrate
  • 10.) Run the local development server:
python manage.py runserver
  • 11.) Type in a URL in the top field.

  • 12.) Name your URL in the bottom field.

  • 13.) You will be redirected to a URL overview page. This page will display some information. The first thing will be the name, when you submitted your URL, then the URL you submitted, and finally, your shortened URL.

  • 14.) Enjoy. ❤️

CHANGELOG ✒️

Version 1.0.0

  • Initial release.
  • Upload to GitHub.

NOTE 📜

  • Shortly ⛓️ 🌎 by Alexander Abraham 🖤 a.k.a. "Angel Dollface" 🎎 🎀
  • Licensed under the MIT license.