Installation Instructions & Usage Documentation

Current Version: 4.1July 2014

Thank you for purchasing clientResponse.
If you have any questions that are beyond the scope of this help file, please do not hesitate to email me via my Code Canyon Profile.
I am always happy to help if you have any questions relating to clientResponse.

For the latest version of this document, please visit the Online Version.

clientResponse is an easy to install, setup and use client management and communication web application built in HTML & CSS, PHP/MySQLi and jQuery.

A Note Before We Get Started

Please read through this entire document BEFORE attempting an installation, or Data Export/Import. If you are planning to export your data from clientResponse V.3, Do NOT delete anything in your old installed version until after you have exported/imported your data, and everything checks out. It is a good rule of thumb to ALWAYS make backups of everything before making ANY changes.


In this version of clientResponse, I wanted to add in a way that you can import your data from your current version (assuming V.3) of clientResponse into the updated version V.4.1. I looked at many ways to accomplish this, and added in what I think is the best. Keep in mind you can only import limited types of data, specifically Clients, Projects, Project Payments and Admins/Managers. I hope this makes transitioning from the last version to the new as easy as possible. Exporting and importing you data is covered in detail in this documentation.

I do want to say a BIG Thank You to all of my buyers for your ideas, suggestions and support. You guys are just Awesome. =)

A. Pre-installation Top

1. Unzip clientResponse and have a look around.

Unzip the clientResponse file and take a look at the file structure. You should see 10 folders and 3 files.

2. Create a Database.

First step is to create a MySQL database, and if you do not have a default one, a database user. This process is explained in great detail on many websites and web hosts. Once you have the database setup, you will need:
The hostname - Usually (but not always - check with your web host) 'localhost'
The database name - ie. clientResponse
The database username - ie: database_user
The database password - ie: database_password

3. Upload clientResponse

Upload all the files you unzipped to your webhost, keeping the file system intact.

Be sure to cmod the avatars, uploads & the admin/templates folders to 755
You should now have the following folders/files on your host account:

B. Installation Top

Run the Online Setup Wizard

Installation is quite easy and only takes a few minutes.

Once clientResponse has finished uploading, simply go to http://www.yoursite.com/clientresponse/ (or wherever subfolder you uploaded it to) and follow the on-screen instructions.
Easy to do, just follow the defaults and plug in your specific information.

1. Server Configuration Check

clientResponse REQUIRES PHP 5.x & MySQLi Connection, and mcrypt_encrypt / mcrypt_decrypt.

There is a Server Configuration Check that will display before you will be able to install clientResponse. If all checks out, great, click the button "Start the Installation". If not, you will not see the "Start the Installation" button and will not be able to install clientResponse. Check with you host, and see if there is anything they can do for you.

2. Database Configuration & Time Zone
clientResponse requires a MySQLi connection in order to run.

Once you have input your database information, click on the "On to Step 2" button.
If you run into any errors here, simply empty the database of any tables that have been created, delete the config.php file from the folder you uploaded clientResponse to, and try again.

If everything was configured correctly, you will see the following:

3. clientResponse Settings

Again, follow the defaults and plug in your site's specific information. You can set your Administrator password and Site name to be anything you would like. Once completed, be sure to hit "On to Step 3" to save your settings.

Installation URL: This should be auto-filled for you*.

*If the Installation URL is not auto-filled, you will need to enter it manually.
This is needed for email notifications. Include any sub-folder clientResponse may be installed in. (ie. http://www.mydomain.com/clientresponse/)
Look at your browser's URL bar, and use that (remove the install/install.php from the end) as your Installation URL.

If you have any questions on this, please do not hesitate to email me via my Code Canyon Profile.

4. The Primary Admin Account

Complete the Primary Admin Account form. This is the main, "Superuser" for clientResponse. This Admin Account cannot be deleted through the web UI, only from within the database (ie. PHPMyAdmin).
Once you have filled in the information for the Primary Admin, click the "Complete Install" button to complete the installation.

Once installation is completed, you will need to go back into your FTP application, and either rename or delete the installation folder on your webhost before you can log in as Administrator.

For security reasons please, DELETE or RENAME the "install" folder, otherwise you will not be able to log in as Administrator.

C. Data Export from clientResponse V.3 Top

If this is your first time using clientResponse, you do not need to do anything special. The Export/Import feature will not effect clientResponse in any way. You can skip to section E.

In clientResponse V.4.1, I have included an export/import feature to make transfering your data to the new version as easy as possible. Keep in mind you can only import limited types of data, specifically Clients, Projects, Project Payments and Admins/Managers. Also, If you choose to import your old data, you will need to do this BEFORE you add any new data through clientResponse. Once you have added any Clients, Projects, or Managers, you will no longer be able to import your old data. This is to prevent duplicate ID's in the database.

1. Upload the export folder to your current (V.3) version of clientResponse

In the zip file you downloaded from CodeCanyon, you will find a folder named "Export clientResponse V3 Data". Inside of that folder is the "export" folder you will need to upload to your current version of clientResponse. Upload it to the main, parent folder.

2. Export Your Data

Once you have uploaded the export folder, complete the export process. Go to your current install of clientResponse
(ie. http://mydomain.com/clientresponse-V3) and type in "/export" to the end of the URL (ie. http://mydomain.com/clientresponse-V3/export). You should see the following:

Click on each of the Export Buttons for the data you want to export. You will get a prompt to either save, or open the CSV File. Save the file to a location on your computer. You will then upload these CSV files to the new version of clientResponse. You do not have to export all data, you may just want to export your clients and nothing else. You can export/import as much data as you need. If you are familiar with CSV files, you could also adjust the exports to your needs. The CSV files the export produces DO NOT have any column headers. Just keep that in mind should you decide to edit the files before importing them into the new version.

D. Importing your clientResponse V.3 Data Top

Now that you have exported you clientResponse V3 data, you can now import it to your new install of clientResponse V.4.1. Start by logging in as the Primary Admin (The Admin account you created when installing). Click on the Admin Tab, then on Site Settings.

Once the Site Settings page has loaded, click on the right-hand tab Import Data.

1. Start Importing Your Data

This page is set up the same as the export page you all ready used. For each type of data (Clients, Projects, Project Payments etc.) there is a button to upload the corresponding CSV file. Click on the Import button for the file you want to upload. In this example I will import my Client data from the CSV file I exported earlier. Browse for the CSV file you saved, then click the Import Clients button.

Once the data has been imported, you will see the following message:

Do this for the remaining data types you want to import. You can always double-check that the data imported correctly by visiting the specific page for that data type - "Active Clients" for Client data import, "Open Projects" for Project data import and so on. If you have any questions about exporting/importing, please do not hesitate to contact me through my CodeCanyon Profile.

E. Site Settings Top

1. clientResponse General Settings

Once clientResponse is installed, you can update the Site Settings after logging in as the Primary Manager. Go to Site Settings page from the Dashboard dropdown menu.

The Site Settings has been broken up into 3 different sections.

A. Global Site Settings
  • Used in Notification emails & Uploads. Must include the trailing slash.Installation URL
  • Choose the Language file to use throughout clientResponse. All Localization files need to be translated from English.Localization
  • Set to No to disable the ability for anonymous users Creating New Accounts.Enable Self-Registrations
  • ie. clientResponse (Appears at the top of the browser, the header logo, in the footer and in other headings throughout the site).Site Name
  • Displayed on Invoices and other areas throughout the site.Business Name
  • The Address of your Business. (Appears in Client's Invoice & the Client's Payment Page)Business Address
  • Used in email notifications as the "from/reply to" email address.Business Email
  • Phone number that Client's can use to contact you.Business Phone
B. Avatar & Upload Settings
  • Pre-populated. Used in Notification emails & Uploads. Must include the trailing slash.Client Upload Directory
  • Pre-populated. Where Client & Admin/Manager Avatars upload to.Avatar Upload Directory
  • Pre-populated. Manager side Only. Where forms/templates upload to.Template Upload Directory
  • Pre-populated. The file types you allow to be uploaded, NO spaces & each seperated by a comma (Format: pdf,doc,docx,txt,xls,csv).Upload File Types Allowed
  • Pre-populated. The Avatar file types you allow to be uploaded, NO spaces & each seperated by a comma (Format: jpg,png).Avatar File Types Allowed
C. Client Payment Settings
  • Set to Yes to use the Payment System.Enable Payments Through PayPal
  • The item name that appears on the PayPal payment. (ie. clientResponse Project Payment).Payment Item name
  • Default is USD (US Dollars).Payment Currency Code
  • Recover the fee charged by Paypal. Decimal ONLY. Do not include '%' symbol (ie. 3.4).PayPal Use Fee
  • What the client will see once they have completed a PayPal payment on the Payment Confirmation Page.Payment Completed Message
  • Your PayPal email - where PayPal payments will be sent to.PayPal Account Email
If you change the name of the Uploads, Templates or Avatars folder, be sure you also update the Site Settings to reflect that change.
2. Localization Files

clientResponse is translation ready. All Localization files are located in two folders: client side is /language and Admin side is /admin/language. If you do not see your language file, you can use any of the other files. Translate the same file on both the Client side and the Admin side, then once complete, upload the translations to your host in the correct folder. You can then set clientResponse to use the files you translated in the Site Settings.

Any language files you may want to use will need to be translated from English.

F. Advanced — Styling & Images Top

1. Custom Styling

While clientResponse already has a modern flat interface based on Twitter's Bootstrap Version 3.1.1, many of you will want to update it to your own liking. This is very easy, however, you will need to be able to write HTML/CSS code. For those that aren't versed, here is a quick overview. The easiest way to change the look is by editing the default CSS files named "clientresponse.css" and "custom.css". Next is to edit the page files, located in both the main and pages folder.

2. Images

clientResponse uses a few images, the Login logo image size is 400px x 31px. The logo in the header once logged in is 258px x 20px. There is also a logo in the footer of all pages, and the size is 180px x 14px. All icons are generated from an Icon Font: Font Awesome (version 4.1.0). Check out all of Font Awesome's icons & usage at: http://fontawesome.io.

Icons & Images can be changed to your liking.

G. Help & Support Top

Please, if you have any questions, run into any issues or just need some help, do not hesitate to contact me.
I believe in providing the best support possible, and I monitor my email just about 24/7.

If you are thinking of giving clientResponse anything less then 5 Stars, please tell me what I can do to make it a 5 Star experience for you.
I love to hear feedback, and welcome any suggestions you may have to make clientResponse better.

H. A Note About FTP Top

If you are having problems with clientResponse after successfully installing and logging in the for the first time you should check your FTP software settings. I have found in many cases that numerous FTP programs are not uploading files correctly.

Check your FTP program to see if it is uploading files in ASCII - which is causing the file code to be uploaded in one long line.
Try changing it to Binary and uploading the files again. Upload everything except the install folder and the config file (or better yet, if you have not started using clientResponse, just wipe the install and the database and reinstall a fresh copy).
I use CuteFTP for my uploads and ran into this problem when all of the sudden everything I was working on just seemed to stop working as expected.