snaker
Snaker is a Python based simple url shortener the Django framework.
Compatibility
- Python 2.7, 3.4, 3.5 and 3.6 (recommended)
- Django 1.8 LTS, 1.9, 1.10, 1.11 LTS, 2.0 (recommended)
- MySQL (recommended), Oracle Database and SQLite and etc.
Usage
-
download the pacakge or fork the package or git clone https://github.com/erishforG/snaker.git
-
python3 pip install -r requeriments.txt
-
vi ~/snaker/snaker/settings.py to change each values (*specific information will be bellow)
-
python3 manage.py run server
-
visit http://127.0.0.1:8000
Documentation
how does snaker works
-
When you register 'LONG URL', snaker will match with 'HASH' code created by itself or oneself who uses snaker.
-
Using base url with hashcode to enter the page, snaker will check the request.
-
snaker will get the information of the user who enter the page and records the data.
-
And then snaker will redirect the page that the user wants.
parameters
base information
BASE_URL = base site url
BASE_TITLE = base site title
BASE_DESCRIPTION = base site description
BASE_IMAGE = base site image
redirect information
-
REDIRECT_IMAGE = redirect page base image
-
REDIRECT_THUMBNAIL = redirect page thumbnail logo below REDIRECT_IMAGE
-
REDIRECT_TIME = redirect delay time
utm setting
- UTM - a simple code that you can attach to a custom URL behind the original code in order to track a source, medium, and campaign name
database
choose your database and set your name, host, id, pw and etc.
contribute
contributers
@erishforG @musalys @wangseung
how to contribute
welcome :) pull requests for bug fixes, new features, and improvements to snaker. Contributors to the main snaker repository must accept MIT License Agreement before any changes can be merged.
License
MIT