1. Start
  2. System Requirements
  3. Change log
  4. Installation
  5. Upgrade
  6. Configuration
  7. Themes
  8. Template
  9. Support
  10. Credits

SM Short URL Script with Stats and Admin panel v2.0

a powerful short url script with stats and admin panel

Thank you for the purchase. This read me file serves you as reference book to avoid misunderstandings for your questions regarding installation and configuration as well as the adjustment of the interface.Lets Begin!

System Requirements

The requirements are pretty basic so just let me write them down here.

  1. PHP5 Server

  2. MySql database

  3. Mod_Rewrite enabled

  4. CSS3 supported web browser

  5. Register_globals enabled

Change log

Created: 03/02/2012
latest Update: 09/05/2012
By: Semantic, Inc.
v2.0

Change Log: v1.0 - v1.5

1. Admin panel overhaul
2. Major improvement in API
3. Added live thumbnail preview
4. Added 5 bonus themes
5. Updated class


Change Log: v1.5 - v1.6

1. Updated shortening class for longer urls

Change Log: v1.6 - v1.6.1

1. Added textarea to contain extra long urls
2. Added new Metro Theme
3. Added character count

Change Log: v1.6.1 - v1.7

1. Completely revamped admin panel

Change Log: v1.7 - v1.8

1. Added hit counter
2. Added Stats page
3. Added QR Codes
4. Minor Bugs fixed
5. Enhanced Stats in admin
6. New dialog alert
7. External qr code fetching to improve speed
8. Added New theme "Grey". A clean and entirely css3 based theme
9. Fixed: QR Code
10. Added Unique Bookmarklet

Change Log: v1.8 - v1.8.1

1. Added MySql data export feature (Export mysql data to ms excel format)
2. Optimized code.

Change Log: v1.8 - v2.0

1. HTML5 Based template (NEW)
2. HTML5 based bootstrap admin panel (NEW)
3. Admin panel changes - shows latest link created (NEW)
4. Admin panel changes - shows latest link created time (NEW)
5. Admin panel changes - shows most times a url clicked (NEW)
6. Admin panel changes - shows most viewed url (NEW)
7. Admin panel changes - icon based menu (NEW)
8. Admin panel changes - export data bug fixed
9. Admin panel changes - Misc bugs fixed
10. Frontend changes - HTML5 based template (NEW)
11. Frontend changes - New statistics system (NEW)
12. Frontend changes - Custom short url (NEW)
13. Frontend changes - New social bookmarking (NEW)
14. Frontend changes - New screenshot API (NEW)
15. Frontend changes - Misc bugs fixes

Installation

The installation is actually very easy and it circles around only 2 files. I am writing down the steps to install and customize.

  1. Unzip the archive to your server

  2. Open "includes/db.php" and fill the database settings (read more in configuration option)

  3. Open "includes/config.php" and fill the optional site settings (read more in configuration option)

  4. Finally import the MySql database from the folder "SQL" in phpMyadmin

  5. Go to admin panel from yourdomain.com/admin and use accordingly by logging inside with Username: "admin" and Password: "admin". You can later change the password from admin panel

  6. Script is all ready now. Feel free to customize the design but DON'T temper the code

  7. The script offers 7 bundled themes: white, grey, citrus, voilet, metro and orange and shadows which you can apply using the config.php file in includes folder

  8. For letting the bookmarklet to function properly, please open bookmarklet.js in the root and replace the current url to your url and save

Upgrade

Since the nature of the coded language is changed from HTML4 to HTML5, you may have to re-install the entire script and replace all the files. Follow the installation procedure to make a clean installation. The next updates will be written in HTML5 as well.

Configuration

Here i will tell you how to configure the necessary installation files db.php and config.php

db.php

1. $db_host - Enter the server address of the mysql server in this field. It is usually localhost in most of the cases

2. $db_user - Enter the database username

3. $db_pass - Enter the database password

4. $db_server - Enter the name of the database you have created and imported the sql file into

 

config.php

1. $title - Enter the name or title for the website

2. $slogan - Enter the slogan or subline for the website

3. $description - Enter description for the website

4. $keywords - Enter keywords for the website so that search engines may find you

5. $adminstatslimit - Enter the number of statistics you want to see in admin panel dashboard. CHOOSE FROM 1-INFINITE

6. $webpath - Enter the url address for the website. Do not include www in the url and also add NO trailing slash in the end. Ex: http://domain.com

7. $footer - Enter footer text or copyright text to be displayed in the website footer. You can add special characters.

8. $stylesheet - This is the part where you will enter the name of your favorite design you want to set default for the website. You have to choose between shadows, orange, voilet, citrus and white. Please do not change case

9. $link_length - Enter here the length of the trimmed url link you want to make. You can choose between 1-10. The value must not exceed above 10. Ex: http://domain.com/abc

Themes

Here you can preview the 5 bundled themes and set it to default accordingly.

1. Shadows theme

 

2. Orange theme

 

3. Voilet theme

 

4. Citrus theme

 

5. White theme

 

6. Metro theme

7. Grey theme

Template

Editing the content is very easy as the script is based on a custom template which you can easily modify by going to the templates folder. The text is clearly written and it won't need any other design, you just have to replace the text and the script will automatically render it with design.

The main frontend text you will find in the create_tpl.php file. Just modify the text but be sure that you don't temper with the function or the script won't serve its purpose.

The API text you can find in the api_tpl.php file.

Support

For support and more inquiries please use the contact form by visiting my codecanyon profile page by clicking below url.

http://codecanyon.net/user/mysticmetal

 

Credits

Thanks to WebsiteIMG for using their live thumbnail preview api in the script.