System Requirements

To installing Quicksupport - Support Tickets System & Knowledge Base, Your web server must be running PHP 5.6 or higher, and Mysql 5 or higher. Below are a list of items you should ensure your host can comply with.

1. PHP 7
2. PHP 5.6+
3. MYSQLi 5.1+
4. MYSQLi Extension
5. CURL Extension (recommended)

Technology

• Codeigniter Version 3.1.10
• Bootstrap Version 4.1.3
• HTML5/ CSS3
• Jquery/ AJAX

Application Features

• Fully AJAX Based System.
• User-friendly Interface and Interaction.
• Multilingual Support.
• Well Documented.
• Users can register account and submit tickets.
• Users can access knowledge base and FAQs.
• User Dashboard and User Profile.
• Guest Ticket Submission without login.
• Article Voting.
• Admin Can Manage Articles and Categories.
• Admin Can Manage FAQs and Categories.
• Admin Can Manage Tickets and Categories.
• Assign Tickets to Support Agents.
• Admin can Manage Users.
• Role Based Permission and User Based Permissions.
• Site Settings, SEO Settings, Social Media Settings and more.

Database Creation

You need to have previously set up database from the cPanel.

Here is a good tutorial how to set up MySQL database in cPanel if you are not familiar with this.

1. Login to cPanel by accessing www.yourdomain.com/cpanel and navigate go MySQL Databases.
2. Create database first.
3. Create user and set up your password.
4. Add the user to database by selecting the database and the username.
5. Open the file Quicksupport.sql in database folder of package files and Import the Database. It will create all required database tables and sample data's.

Make sure you have checked All privileged when adding the user to database.

Setup Base URL

After Uploading files form script folder to your domain. Go to application/config/config.php and setup $config['base_url'] where Quicksupport will be installed.

You need to add your base URL to this line.

                                $config['base_url']	= "";
                        

Ex. If you are installing on subdomain you will set http://www.Quicksupport.domain.com/

Ex. If you are installing on subfolder you will set http://www.domain.com/Quicksupport/

Ex. If you are installing on main domain you will set http://www.domain.com/

                                $config['base_url']	= "http://www.Quicksupport.domain.com/";
                        

Database Configuration

Open your site main root folder then open: application/config/database.php Change your database name, username and password here.

                            $db['default'] = array(
                                'dsn'	=> '',
                                'hostname' => 'your_database_hostname_here',
                                'username' => 'your_database_username_here',
                                'password' => 'your_database_password_here',
                                'database' => 'support',
                                'dbdriver' => 'mysqli',
                                'dbprefix' => '',
                                'pconnect' => FALSE,
                                'db_debug' => (ENVIRONMENT !== 'production'),
                                'cache_on' => FALSE,
                                'cachedir' => '',
                                'char_set' => 'utf8',
                                'dbcollat' => 'utf8_general_ci',
                                'swap_pre' => '',
                                'encrypt' => FALSE,
                                'compress' => FALSE,
                                'stricton' => FALSE,
                                'failover' => array(),
                                'save_queries' => TRUE
                            );
                        

Once you did everything correctly your site is ready to user, navigate to your base URL to access site.

Site Layout

Go to the root directory of application and open file /application/views/site/_layout.php Here you can set navigation and Account Buttons.

Admin Layout

Go to the root directory of application and open file /application/views/admin/_layout.php Here you can set navigation and Account Buttons.

Routes

If you want to change routes of site, Go to the root directory of application and open file /application/config/routes.php. Here you can change the route according to your requirements.

                                $route['default_controller'] = 'pages';
                                $route['404_override'] = '';
                                $route['translate_uri_dashes'] = TRUE;
                                
                                //Site Pages
                                $route['search'] = 'pages/search';
                                $route['articles'] = 'pages/articles';
                                $route['articles/category/(:any)'] = 'pages/categories/$1';
                                $route['article/(:any)'] = 'pages/article/$1';
                                $route['faq'] = 'pages/faq';
                                $route['submit-ticket'] = 'pages/submit_ticket';
                                $route['contact'] = 'pages/contact';
                                $route['login'] = 'auth/login';
                                $route['logout'] = 'auth/logout';
                                $route['register'] = 'auth/register';
                                $route['activation/(:any)'] = 'auth/activation/$1';
                                $route['forgot-password'] = 'auth/forgot_password';
                                $route['reset-password/(:any)'] = 'auth/reset_password/$1';
                                $route['reset_password_action'] = 'auth/reset_password_action';
                                $route['switch/(:any)'] = 'pages/switch_language/$1';
                                
                                //Admin Authentication
                                $route['admin/login'] = 'admin/auth/login';
                                $route['admin/logout'] = 'admin/auth/logout';
                                $route['admin/forgot-password'] = 'admin/auth/forgot_password';
                                $route['admin/reset-password/(:any)'] = 'admin/auth/reset_password/$1';
                                //Admin Profile
                                $route['admin'] = 'admin/profile/dashboard';
                                $route['admin/profile'] = 'admin/profile/index';
                                $route['admin/change-password'] = 'admin/profile/change_password';
                                $route['admin/switch/(:any)'] = 'admin/profile/switch_language/$1';
                                //Admin Articles
                                $route['admin/articles'] = 'admin/articles/list_articles';
                                $route['admin/article/view'] = 'admin/articles/view_article';
                                $route['admin/article/add'] = 'admin/articles/add_article';
                                $route['admin/article/create'] = 'admin/articles/create_article';
                                $route['admin/article/edit'] = 'admin/articles/edit_article';
                                $route['admin/article/update'] = 'admin/articles/update_article';
                                $route['admin/article/ordering'] = 'admin/articles/article_ordering';
                                $route['admin/article/update_ordering'] = 'admin/articles/update_article_ordering';
                                $route['admin/article/publish'] = 'admin/articles/publish_article';
                                $route['admin/article/unpublish'] = 'admin/articles/unpublish_article';
                                $route['admin/article/delete'] = 'admin/articles/delete_article';
                                $route['admin/article/categories'] = 'admin/articles/categories';
                                $route['admin/article/category/view'] = 'admin/articles/view_category';
                                $route['admin/article/category/add'] = 'admin/articles/add_category';
                                $route['admin/article/category/create'] = 'admin/articles/create_category';
                                $route['admin/article/category/edit'] = 'admin/articles/edit_category';
                                $route['admin/article/category/update'] = 'admin/articles/update_category';
                                $route['admin/article/category/ordering'] = 'admin/articles/categories_ordering';
                                $route['admin/article/category/update_ordering'] = 'admin/articles/update_categories_ordering';
                                $route['admin/article/category/delete'] = 'admin/articles/delete_category';
                                //Admin Tickets
                                $route['admin/tickets'] = 'admin/tickets/list_tickets';
                                $route['admin/ticket/view'] = 'admin/tickets/view_ticket';
                                $route['admin/ticket/assign'] = 'admin/tickets/assign_ticket';
                                $route['admin/ticket/reply'] = 'admin/tickets/reply_to_ticket';
                                $route['admin/ticket/delete'] = 'admin/tickets/delete_ticket';
                                $route['admin/ticket/completed'] = 'admin/tickets/mark_ticket_completed';
                                $route['admin/ticket/incompleted'] = 'admin/tickets/mark_ticket_incompleted';
                                $route['admin/ticket/categories'] = 'admin/tickets/categories';
                                $route['admin/ticket/category/add'] = 'admin/tickets/add_category';
                                $route['admin/ticket/category/create'] = 'admin/tickets/create_category';
                                $route['admin/ticket/category/view'] = 'admin/tickets/view_category';
                                $route['admin/ticket/category/edit'] = 'admin/tickets/edit_category';
                                $route['admin/ticket/category/update'] = 'admin/tickets/update_category';
                                $route['admin/ticket/category/ordering'] = 'admin/tickets/categories_ordering';
                                $route['admin/ticket/category/update_ordering'] = 'admin/tickets/update_categories_ordering';
                                $route['admin/ticket/category/delete'] = 'admin/tickets/delete_category';
                                //Admin FAQ
                                $route['admin/faqs'] = 'admin/faq/list_faqs';
                                $route['admin/faq/view'] = 'admin/faq/view_faq';
                                $route['admin/faq/add'] = 'admin/faq/add_faq';
                                $route['admin/faq/create'] = 'admin/faq/create_faq';
                                $route['admin/faq/edit'] = 'admin/faq/edit_faq';
                                $route['admin/faq/update'] = 'admin/faq/update_faq';
                                $route['admin/faq/ordering'] = 'admin/faq/faq_ordering';
                                $route['admin/faq/update_ordering'] = 'admin/faq/update_faq_ordering';
                                $route['admin/faq/publish'] = 'admin/faq/publish_faq';
                                $route['admin/faq/unpublish'] = 'admin/faq/unpublish_faq';
                                $route['admin/faq/delete'] = 'admin/faq/delete_faq';
                                $route['admin/faq/categories'] = 'admin/faq/categories';
                                $route['admin/faq/category/view'] = 'admin/faq/view_category';
                                $route['admin/faq/category/add'] = 'admin/faq/add_category';
                                $route['admin/faq/category/create'] = 'admin/faq/create_category';
                                $route['admin/faq/category/edit'] = 'admin/faq/edit_category';
                                $route['admin/faq/category/update'] = 'admin/faq/update_category';
                                $route['admin/faq/category/ordering'] = 'admin/faq/categories_ordering';
                                $route['admin/faq/category/update_ordering'] = 'admin/faq/update_categories_ordering';
                                $route['admin/faq/category/delete'] = 'admin/faq/delete_category';
                                //Admin Users
                                $route['admin/users'] = 'admin/users/list_users';
                                $route['admin/user/view'] = 'admin/users/view_user';
                                $route['admin/user/add'] = 'admin/users/add_user';
                                $route['admin/user/create'] = 'admin/users/create_user';
                                $route['admin/user/edit'] = 'admin/users/edit_user';
                                $route['admin/user/update'] = 'admin/users/update_user';
                                $route['admin/user/block'] = 'admin/users/block_user';
                                $route['admin/user/unblock'] = 'admin/users/unblock_user';
                                $route['admin/user/delete'] = 'admin/users/delete_user';
                                //Admin Settings
                                $route['admin/settings/site'] = 'admin/settings/site_settings';
                                $route['admin/settings/social-media'] = 'admin/settings/social_media_settings';
                                $route['admin/settings/seo'] = 'admin/settings/seo_settings';
                                $route['admin/settings/permissions'] = 'admin/settings/permissions';
                                $route['admin/settings/app'] = 'admin/settings/app_settings';
                        

Theming

If you want to customize color theme of your application. Open assets/scss/_variable.scss file and change color value of following variables.

                            // Theme Colors Solid
                            $theme-primary-color : #1d2c63;
                            $theme-secondary-color : #40b1dd;
                        

Open assets folder using terminal, Then run following command.

                            sass --watch scss:css
                        

This will regenerate your CSS files. Then upload all files of /assets/css/ to corresponding folders of server.

Dashboard

Dashboard shows the overview. You can see information about articles, tickets, FAQs and users.

1. Total Number of Articles.
2. Total Number of Tickets.
3. Total Number of FAQs.
4. Total Number of Users.
5. Recent Tickets.
6. Recent Articles.

Articles

Select Knowledge Base -> Articles from left side menu. All Articles listed here. You can filter articles, create articles, view article, edit article, publish/unpublish article, delete article and change order of articles.

1. All articles listed here
2. To filter articles list enter filter values and click on Filter Article button.
3. To Create new article click on Add Article Button.
4. To view article click on 3 dots located in right side article then select View.
5. To edit article click on 3 dots located in right side article then select Edit.
6. To publish/unpublish article click on 3 dots located in right side article then select Publish/Unpublish.
7. To delete article click on 3 dots located in right side article then select Delete.
8. To change order of articles click on Article Ordering tab, Then select article category from dropdown, then drag and drop article title to the positions.

Select Knowledge Base -> Article Categories from left side menu. All Article Categories listed here. You can create category, edit category, view category, delete category and change order of category.

1. All articles categories listed here.
2. To change order of categories click on Categories Ordering tab, Then drag and drop category names to the positions.
3. To Create new category click on Add Category Button.
4. To view category click on 3 dots located in right side category then select View.
5. To edit category click on 3 dots located in right side category then select Edit.
6. To delete category click on 3 dots located in right side category then select Delete.

Tickets

Select Tickets -> List Tickets from left side menu. All tickets listed here. You can filter tickets, view and reply to ticket, assign tickets to admin users, marks as completed/mark as incompleted tickets and delete ticket.

1. All tickets listed here.
2. To filter tickets list enter filter values and click on Filter Tickets button.
3. To view and reply to ticket click on 3 dots located in right side ticket then select View and Reply. A new window will Open with two tabs. In Ticket Info you can view ticket details. In Reply to Ticket tab you can reply to the ticket.
4. To assign ticket to other admin users click on 3 dots located in right side ticket then select Assign.
5. To complete/incomplete ticket click on 3 dots located in right side ticket then select Mark as Completed/Mark as Incompleted.
6. To delete ticket click on 3 dots located in right side ticket then select Delete.

Select Tickets -> Ticket Categories from left side menu. All Ticket Categories listed here. You can create category, edit category, view category, delete category and change order of category.

1. All ticket categories listed here.
2. To change order of categories click on Categories Ordering tab, Then drag and drop category names to the positions.
3. To Create new category click on Add Category Button.
4. To view category click on 3 dots located in right side category then select View.
5. To edit category click on 3 dots located in right side category then select Edit.
6. To delete category click on 3 dots located in right side category then select Delete.

FAQs

Select FAQ -> List FAQ from left side menu. All FAQ listed here. You can filter FAQ, create FAQ, view FAQ, edit FAQ, publish/unpublish FAQ, delete FAQ and change order of FAQs.

1. All FAQ listed here.
2. To filter FAQs list enter filter values and click on Filter FAQ button.
3. To Create new FAQ click on Add FAQ Button.
4. To view FAQ click on 3 dots located in right side FAQ then select View.
5. To edit FAQ click on 3 dots located in right side FAQ then select Edit.
6. To publish/unpublsh FAQ click on 3 dots located in right side FAQ then select Publish/Unpublish.
7. To delete FAQ click on 3 dots located in right side FAQ then select Delete.
8. To change order of FAQ click on FAQ Ordering tab, Then select FAQ category from dropdown, then drag and drop FAQ title to the positions.

Select FAQ -> FAQ Categories from left side menu. All FAQ Categories listed here. You can create category, edit category, view category, delete category and change order of category.

1. All FAQ categories listed here
2. To change order of categories click on Categories Ordering tab, Then drag and drop category names to the positions.
3. To Create new category click on Add Category Button.
4. To view category click on 3 dots located in right side category then select View.
5. To edit category click on 3 dots located in right side category then select Edit.
6. To delete category click on 3 dots located in right side category then select Delete.

Users

Select Users -> List Users from left side menu. All Users listed here. You can filter User, create User, view User, edit User, block/unblock User and delete User.

1. All Users listed here.
2. To filter Users list enter filter values and click on Filter Users button.
3. To Create new User click on Add User Button.
4. To view User click on 3 dots located in right side User then select View.
5. To edit User click on 3 dots located in right side User then select Edit.
6. To block/unblock User click on 3 dots located in right side User then select Block/Unblock.
7. To delete User click on 3 dots located in right side User then select Delete.

Select Users -> User Permissions from left side menu. You give special permission to specific admin users rather than role based permission.

1. Select an Admin User you wan to give special permission and click on Filter Permissions Button.
2. All Permissions of that user will list here.
3. Toggle the Action button right to permission name for giving access or removing access.

Settings

Select Settings -> Site Settings from left side menu. Here you can update site name, logo, favicon, email and phone.

1. Change to your values and click on Save Settings Button.

Select Settings -> Social Media Settings from left side menu. Here you can update social media links.

1. Change to your values and click on Save Settings Button.

Select Settings -> SEO Settings from left side menu. Here you can update SEO Related Information.

1. Change to your values and click on Save Settings Button.

Select Settings -> Permissions from left side menu. Here you can update Role Based Permissions.

1. You can filter the permission by its name.
2. Toggle the Action button permission name/role name for giving access or removing access.

Select Settings -> App Settings from left side menu. Here you can update basic app configurations.

1. Toggle the Action button right to setting name for enable/disable.
2. Click on Save Settings Button.

Select Settings -> Email Settings from left side menu. Here you can update Email related and SMTP details.

1. Change to your values and click on Save Settings Button.

Select Settings -> Email Templates from left side menu. Here you can update all email templates.

1. Click the edit button to edit template.

Profile

Here you can update name, phone, email and profile image.

1. Click on User icon from right header, Then select Profile Menu.
2. Click on Edit icon profile image, Then select an image and crop image to update profile image.
3. Change to your values and click on Update Profile Button.

Here you can update your password.

1. Click on User icon from right header, Then select Profile Menu.
2. Click on Change Password link from user menu.
3. Change to your values and click on Change Password Button