Intro
E-commerce Site Kit-1 is a database-driven CMS (Content Management System) for building and managing e-commerce websites. It`s designed for users who would like to have their own fully functional automated website for representing and selling any intangible and tangible goods online.Operating of E-commerce Site Kit doesn`t require any programming skills. Any computer-literate person can build and manage his/her own totally independent e-commerce website using E-commerce Site Kit in a very short period of time.
In this Manual we will show you how to build and manage your very own professionally designed e-commerce website.
Installation
E-commerce Site Kit works on real web servers only, it will not work on your local computer. You have to have a website in order to install E-commerce Site Kit. Also you have to have a Business PayPal account to sell your products online. If you don`t have it yet please visit PayPal and sign up. Signing up with PayPal is easy and FREE!Before you proceed with installation please make sure that you have a web-hosting account with all necessary features according to E-commerce Site Kit`s Server Requirements.
Server Requirements
Majority of web-hosting companies have all these Server Requirements set up by default for their clients, but you better verify it before proceeding with installation:- Apache web server - E-commerce Site Kit won`t work with IIS or other web servers.
- PHP 4.4.8 - Your web server must have PHP 4.4.8 or greater, with 5.2.0 being highly recommended.
- MySQL database - Your web server must be setup to allow database access. MySQL 4 or later required. MySQL 4.1 is highly recommended.
- Access to CPanel (or some other web-hosting Control Panel like Ensim, Plesk etc.) - you need this to set up a blank database with database user and password.
- Zend Optimizer - version 2.1.0 or newer.
- ImageMagick - software suite for automatic image processing.
- mod_rewrite - Apache Web server module required to generate Search Engine Friendly URLs.
- FTP Access - You will be transferring files from your local computer to your website, so you will need some "File Transfer Protocol" client software.
- Write Access - You should have permission to make files and directories writable on your web-hosting account.
Pre-Installation Setup
- Create a blank MySQL database, database user and database password using web-hosting Control Panel database tools.
- Upload all files from the E-commerce Site Kit package to the root of your website using FTP client or File Manager of your web-hosting`s Control Panel.
Important: if you uploading files via FTP please make sure that index.php and all php files from the folders admin, lib, app/controllers, app/models and app/vendors uploaded in binary mode. - Set write permissions (CHMOD 777) to the following folders: categoryimages, feeds, productfiles, productimages, includes\images.
- Set write permissions (CHMOD 666) to the following files: _dbconfig.php, feeds/gbase.txt, feeds/rss.xml, includes/css/store.css.
Installation Procedure
Skip this paragraph if you upgrading E-commerce Site Kit to the newer version from the upgrade package.Type in the address bar of your browser: http://www.yourWebsite.com/install (with your actual domain instead of yourWebsite.com) and press "Enter" on your keyboard.
- Please specify MySQL database connection - fill up in the fields connection info to the database that you already created in Pre-Installation Setup.
- Click "Continue" button, verify information that you just entered and if everything`s OK click "Continue" button again.
- If you see the page "Setup of the database has been finished successfully!" then follow the Post-installation instructions.
Post-installation
- Remove the file /app/controllers/class.install_controller.php from your server.
- Change permissions (CHMOD 644) to the file _dbconfig.php
- Login to Admin Panel of E-commerce Site Kit using both User and Password as
admin
and change it as soon as possible. - Congratulations! Now you have completed installation of E-commerce Site Kit.
Settings
Admin Account
When logged in Admin Panel of E-commerce Site Kit for the first time please click on "Settings" and change Admin Account credentials:- Admin Username - change it to something different than "admin" and easy memorisable for you.
- Admin Password - please use some combination of numbers and letters that is hard to guess.
- Admin Email - type here some valid email address. It will be used by system to send you error notifications.
Customer Support
- Company Name - your customers will see it as a Sender Name in e-mails from your website.
- Customer Support Email - type here some valid email address. It will be used to receive messages sent by "Contact Us" form and also for email communications with your customers.
- Web site URL - type here your website URL including http:// or https:// . It will be used in download links sent by payment confirmation scripts.
Download Manager
- Download Limit - specify here the number of allowed downloads of each purchased intangible product. Put here 0 if you want your customers to have unlimited number of downloads of purchased intangible products.
- Download Exp Period - type here the number of days you wish to keep the download link of each purchased intangible product alive. Put here 0 if you wish to keep the download link alive forever.
Layout
Here you can set up the identity of your website and customize its layout.- Website Logo - shows you the name of the graphic file currently
used as website logo.
Click on the button Upload New Logo if you wish to change it. In the new window you will see the current logo in its original size and "File on your computer" field with button Browse - click on the button to choose and upload a graphic file from your computer that you`d like to use as logo on your website.
Please note - file must be in the following graphic formats only: jpg, gif, png. Size of the file must be less than 70px in height to fit the current design. If you`d like to change the current design you have to customize website style sheet file and its accompanying graphic files. - Website Name - here you can type the name of your website that will show up to the right of your logo.
- Website Style - shows you the name of currently
used style sheet file. Entire design of the website is based on this file. If
you are familiar with CSS and computer graphics you will be able to change
design and layout of your website by editing this file.
Click on the button Edit Stylesheet to customize it. - Default Meta Title - content of the meta tag Title on your Home Page. Type here the title of your website within recommended 64 characters length - it will be used by search engines to index your website.
- Default Meta Description - content of the meta tag Description on your Home Page. Type here the description of your website within recommended 150 characters length - it will be used by search engines to index your website.
- Default Meta Keywords - content of the meta tag Keywords on your Home Page. Type here the keywords related to Home Page of your website - it will be used by search engines to index your website.
Navigation
- Products per Page (Store) - set here the number of your products to show on one page of your website store.
- Products per Page (Admin) - set here the number of your products to show on one page in Admin Panel`s Products page.
- Navigation length (Store) - set here the sliding number of pages to show on the navigation panel of your website store.
- Navigation length (Admin) - set here the sliding number of pages to show on
the navigation panel of your Admin Panel`s Products page.
Tax Calculation
- Tax Rate - set here percentage of Tax Rate that should be applied to Product Price in Shopping Cart. Set it to 0 if you don`t want to apply any taxes in Shopping Cart.
- Tax included in price - switch between Y(yes) or N(no). In Europe and Australia taxes must be included in Product price. Set it to N if taxes must be applied upon the Product price (USA and Canada).
- Shipping taxable - switch between Y(yes) or N(no). Set it to N if you don`t want to apply taxes on shipping cost.
Content
- Right Column Content (HTML) - here you can put and edit HTML and/or JavaScript content of the Right Column of your website. For instance: some graphic banners, flash advertising or Google AdWords.
- Footer Content (HTML) - here you can put and edit HTML and/or JavaScript content of the Footer of your website. For instance: copyright notice, some graphic banners, or Google AdWords.
Pages
Table of Static Pages shows all pages available on the site, their status and actions to manage them. Use icon buttons in the Column Action to manage your pages:
-
use this buttons to change the order of links to your pages in the menus.-
-
use this button if you want to duplicate the page. -
-
use this button if you want to delete the page from your site permanently.
Please be careful with it, because there is no way to restore the page after
deletion. -
-
use this button if you want to make the page a default Home Page of your
website.
Page Editor
Using Page Editor you can create and edit static pages of your website.- URL - type here the name of the Page`s HTML file that will
be used as the referring address to the page on your website. Only numbers, letters,
underscores and hyphens are allowed. No spaces, punctuations and any
special characters - they are not supported by HTTP as parts of URL.
Good example of the URL field: my1-page
Bad example of the URL field: my,$ page
Also you can type here a full URL to some page on the Internet that doesn`t belong to your website, e.g.: http://www.someWebsite.com/somePage.html - External URL - put a checkmark here if you are linking to some other website in the URL field.
- Link Name - type here the Name of the link to your page as it should appear on the top and bottom menu of your website. Try to avoid a long names, because you have a limited space on the site`s menu. If you want to put a longer name you can use the next field for this purpose:
- Tool Tip - here you can type a longer name of the link to your page that will appear as a toll tip when a visitor points a mouse to the link.
- Status - select a status of your page here:
- Published (link in menu) - page is published and visible for visitors of your website in the top and bottom menu.
- Hidden (no link in menu) - page is published and accessible by its URL, but is not listed in the top and bottom menu. You can use this status for any additional pages that you do not want to show in the site`s menu.
- Under Construction (no access) - use this status if you didn`t finish the page and you don`t want to show it on your site to anyone.
- Title Meta Tag - type here title of your page as you want it to appear to search engines.
- Keywords Meta Tag - type here keywords related to the content of your page as you want it to appear to search engines.
- Description Meta Tag - type here description of your page as you want it to appear to search engines.
- Page Content - here goes the content of your page. You can
put here HTML formatted text, images, Flash animation and JavaScript.
Online WYSYWIG (What You See Is What You Get) HTML Content Editor will help to create a well formatted rich content for your pages.
If you want to display list of your featured products on the page - you can put there the following code:
Categories
Table of Categories shows all categories of your products, their relations and actions to manage them. Use icon buttons in the Column Action to manage your categories:
-
use this buttons to change the order of links to your categories in the menus.-
-
use this button if you want to delete the category.
Category Editor
Using Category Editor you can create, edit and manage category tree of your products.- URL - type here the name of the Category HTML file that will
be used as the referring address to the Category page on your website. Only numbers, letters,
underscores and hyphens are allowed. No spaces, punctuations and any
special characters - they are not supported by HTTP as parts of URL.
Good example of the URL field: my1-products
Bad example of the URL field: my,$ products - Keywords Meta Tag - type here keywords related to the content of your category page as you want it to appear to search engines.
- Description Meta Tag - type here description of your category page as you want it to appear to search engines.
- Description - here goes description of your
category as it appears to the site`s visitors. You can
put here HTML formatted text, images, Flash animation and JavaScript. You
can even make the category as a page with a static content without
assigning any products to it. Or just don`t put anything here.
Online WYSYWIG (What You See Is What You Get) HTML Content Editor will help to create a well formatted rich content here. - Image - here you can upload some image or flash animation to the header of the category. If you going to upload flash swf-file please specify it in the selector Image Type by selecting "flash". Default size of the flash object is set to 468px by 60px. You can change it by editing class "catimage" of the "store.css" stylesheet file.
- Category Relation - use this selector to assign the category as a Top Category or under any existing category from the pull-down list of your categories.
- Products - here you can assign and manage list of products related to this category.
Manufacturers
Table Manufacturers shows the list of brands of your products. If you are going to sell your products please put your company name as a manufacturer by clicking on
Products
Product List page shows product search engine, catalog of your products, their SKUs, URLs, Names, Price, visibility status andColumn SKU shows clickable product codes. If click one - it opens the Product Editor. Also you can open Product Editor by clicking on
Product Editor
Using Product Editor you can create and edit product pages.- SKU - type here some unique code-identifier of the product. Please be careful, because different products with the same SKU can create confusion.
- URL - type here the name of the product`s HTML file that will
be used as the referring address to the product page on your website. Only numbers, letters,
underscores and hyphens are allowed. No spaces, punctuations and any
special characters - they are not supported by HTTP as parts of URL.
Good example of the URL field: my1-product
Bad example of the URL field: my,$ product
- Manufacturer - select here the product`s brand from the previously created list of manufacturers.
- Featured Product - put a checkmark here if you want to display this product in the Featured Products list.
- Visible - put a checkmark here if you want this product to be visible on your site. You can uncheck it if the product is out of stock or temporally unavailable.
- Type of Product - Select type of the product:
- Tangible - the product is tangible and must be delivered to customers by mail.
- Intangible (download) - the product is intangible Downloadable Content such as MP3, software, eBook, video file etc.
- Intangible (license) - the product is intangible Informational Item such as license number, serial number, ticket number etc.
- Additional Info - Tangible Product.
Quantity in Stock - type here the number of available items for sale. When number of items reaches 0 your visitors will not be able to purchase the product. They will see "Out of Stock" message instead of "Add to Cart" button.
Shipping Cost - put here the Shipping cost of your product. Use only numbers and decimal point. No any other characters are allowed here. - Downloadable Content - Intangible (download).
if you are going to sell an intangible product such as MP3s, software, eBooks, video files etc. - you can upload it here. Uploaded file will be automatically available for download to the buyer right after PayPal will approve buyer's payment. If the file is less than 8Mgb in size you can upload it here using Select File on your computer form under the tab Upload File.
If the file is more than 8Mgb in size you must upload it first to the folder /productfiles/ using any FTP client program. When file is uploaded you can specify the file name in the field Type Name of the File under the tab Use File Uploaded via FTP.
If the file is already uploaded you will see the table with file`s information and checkmark Delete. Put the checkmark on if you`d like to delete the file. - Product Key - Intangible (license).
Type or paste the list of comma-delimited numbers in the textarea. Each sold number will be automatically deleted from the list.
- Name/Title - type here the name of your product - it will be shown as a title of the product page and also it will be used as Title Meta Tag for search engines.
- Short Description / Meta Tag - type here description of your product as you want it to appear to search engines. Also it will be used as a short description of the product shown on catalog pages as a product's tool tip. Try to keep it in 150 characters range.
- Keywords Meta Tag - type here keywords related to the content of your product page as you want it to appear to search engines.
- Description - here goes the content of the product
page. You can put here HTML formatted text, images, Flash animation and
JavaScript.
Online WYSYWIG (What You See Is What You Get) HTML Content Editor will help to create a well formatted rich content here. - Options - here you can select the product options from the list of previously created Product Options.
- Price - put here the price of your product. Use only numbers and decimal point. No any other characters are allowed here.
- Product Images - table of the previously uploaded images. If you want to delete some just put a checkmark against the image you want to delete in the Action column.
- Upload Images - use this form to upload images of your
product. Images must be in jpg, gif, png formats only. If you uploading 5
images in one pack please make sure that your images are not exceeding 8 Mb
(megabytes) in total. Number of images per product is unlimited. Uploaded images will be automatically resized to
the default
dimensions:
160px in width 80px in height for thumbnails and
520px in width 520px in height for images.
If you would like to change these values you can do it by editing the corresponding settings in _config.php file located in the root of your website. - Product Categories - is a table of categories where the
product belongs. You can add the product to the categories from the
pull-down menu by selecting some category and clicking on
icon. Clicking
on
icon will remove the product from the corresponding category. - Related Products - is a table of products that you can specify as related to the current product. These products will be shown below description on the product page. Use Add Related Product selector to add related products and Delete button to remove them from the table.
Featured Products
Featured Products - is a table of products that you previously selected as featured in the Product Editor. If click on a particular product in the SKU column - it will open this product in the Product Editor. Here is a JavaScript code to display the List of Featured Products on any page of your website:
Options
Product Options table shows list of your option sets.Column Name shows clickable option names. If click one - it opens the Product Options Editor. Also you can open Product Options Editor by clicking on
Product Options Editor
- Options Name - type here some unique name of your Options, for example: T-Shirt Options.
- Option Set1 Name - type here some unique name of your Option Set1, for example: Size.
- Option Set1 Choices - type here the list of available
choices and its price difference divided by colon, 1 choice per line. For
example:
numbers mean the difference in price, e.g.: 3 is $3 more than regular price that has been set in the Product Editor for the products where you`re going to use this Option Set. If some choice doesn`t affect the product`s price then type 0 against it. - Option Set2 Name - if you need 2 different option sets for one product - you can designate it here, for example: Color.
- Option Set2 Choices - type here the list of available
choices and its price difference divided by colon, 1 choice per line. For
example:
Orders
Product table shows orders search engine and list of your orders, their Number, Date, Amount, Status and Transaction number. You can sort orders by their Number, Date, Amount and Status by clicking on the column titles. Also you can search for some order by its number using Find Order search engine.If you wish to delete some orders, just put corresponding checkmarks and press Delete Selected button.
Column Order# shows clickable product numbers. If click one - it opens the Order Details page.
Order Details
Order Details Table shows list of ordered products their SKUs, Names, Quantities, Prices, Shipping fees and Total amount.Customer Info Table shows Customer's IP, Billing Address, E-mail Address and Shipping Address.
Order Comments shows comments left by a customer along with his/her order.
Order Status - here you can manage the status of the order:
- Pending - payment in progress
- Received - order received but not paid yet
- Paid - payment completed, you can ship products
- Shipped - order was shipped to the customer
- Cancelled - order has been canceled by the customer
Payment Systems
Payment Systems - is a table of available payment gateways. In the current version of E-commerce Site Kit only PayPal is supported. Currently only PayPal provides reliable API system to control payments in the real time to sell intangible products with automatic immediate delivery to customers via direct download from the site.You have to have a Business PayPal account to sell your products online. If you don`t have it yet please visit PayPal and sign up.
If you click on PayPal in the column Name it opens PayPal Settings page:
- Use - put here a checkmark if you want to use this payment gateway.
- business - type here your PayPal primary email address.
- return - replace here
www.yourWebsite.com with your actual domain name while preserving the
rest of the line:
- cancel_return - replace here
www.yourWebsite.com with your actual domain name while preserving the
rest of the line:
- notify_url - replace here
www.yourWebsite.com with your actual domain name while preserving the
rest of the line:
- currency_code - type here PayPal currency code of your country or your preferred currency that you`d like to use on your site.
- auth_token - paste here auth_token value directly from
PayPal:
- Log in to your PayPal account
- Click on "Profile"
- Click on "Website Payment Preferences" in the column "Selling Preferences"
- Select "Auto Return" On
- Type Return URL exactly as it`s shown above in the return
field with your own domain:
- Switch Payment Data Transfer On
- Click on the button "Save"
- After that PayPal will show you Identity Token - copy and paste it into the auth_token field.
- submit button - if you want to change text on the payment button - you can do it here.
Important: you must have PayPal Business or PayPal Premium account to use PayPal with E-commerce Site Kit.
Data Feeds
Here you can generate the following data feeds:- RSS - click on "Generate RSS Datafeed" and it opens page with link to the generated data feed. RSS icon on the left column of your website is connected to this link, so if you want to refresh info in your RSS Datafeed you have to click on "Generate RSS Datafeed" when your updated your products.
- Google Base - click on "Generate Google Base DataFeed" and it opens page with link to the generated data feed. Get more info about Google Base.
Newsletters
Newsletters table shows list of your newsletters that you sent or going to send to your customers.Column Title (click to edit) shows clickable newsletter names. If click one - it opens the Newsletter Editor. Also you can open Newsletter Editor by clicking on
Column Status shows the status of the current newsletter.
Column Delete shows the delete
Newsletter Editor
Using Newsletter Editor you can create, edit and manage your newsletters.- Title - type here the name of the newsletter. Your customers will not see it - it's used only for administrator
- Subject - type here the subject of your newsletter as you want it to appear to your customers.
- Body - here goes the content of your
newsletter as it appears to your customers. You can
put here HTML formatted text, images and Flash animation.
Important: You have to use absolute URLs to your images or flash, otherwise recipients of your newsletter will not be able to see them.
Online WYSYWIG (What You See Is What You Get) HTML Content Editor will help to create a well formatted rich content here.
Confirm
Test Newsletter - click on "Send Test" to send a newsletter to adman's email address.Send Newsletter - click on "Send" to send a newsletter to your customers.
Customization
Customizing design and layout of the site built with E-commerce Site Kit required basic knowledge of HTML/XHTML, CSS and computer graphic software such as Photoshop, Paint Shop, Photo-Paint etc.Most of design modifications can be done by editing Style Sheet CSS file using Style Editor of the Settings section. You can also edit style sheet file using Adobe Dreamweaver or any other similar software, e.g. TopStyle Pro. You can also keep several design themes by using different CSS files and switching between them in Website Style field of the Settings section.
If you need to change some wording used in E-commerce Site Kit you can do it by editing PHP template files located in the "app/views/" folder. Here is a table of files that you can modify to customize an appearance of your website:
| Location | Description |
|---|---|
| /includes/css/store.css | Main style sheet file of the site |
| /includes/css/editor.css | Style sheet file with styles used in pull-down menu Styles of HTML Editor |
| /includes/images/ | Folder with images used on the site |
| /app/views/_layout_default.tpl.php | Main layout template |
| /app/views/_layout_checkout.tpl.php | Main shopping cart checkout template |
| /app/views/404.tpl.php | 404 error (file is not found) template |
| /app/views/category/display.tpl.php | Main template for browsing of categories |
| /app/views/category/featured.tpl.php | Featured Products template |
| /app/views/category/search.tpl.php | Search results template |
| /app/views/checkout/cart.tpl.php | Shopping Cart template |
| /app/views/checkout/checkout.tpl.php | Checkout template |
| /app/views/checkout/pay.tpl.php | Processing Payment template |
| /app/views/checkout/thankyou.tpl.php | "Thank you for your order" template |
| /app/views/download/order.tpl.php | Download page template |
| /app/views/download/error.tpl.php | "Order is not found" template |
| /app/views/email/order_confirmation.tpl.php | Order confirmation email message to customer |
| /app/views/email/order_confirmation_admin.tpl.php | Order confirmation email message to admin |
| /app/views/email/paypal_ipn.tpl.php | Email message to customer with Download link |
| /app/views/forms/contactus.tpl.php | Contact Us form template |
| /app/views/forms/thankyou.tpl.php | Contact Us form "Thank you" template |
| /app/views/layout/menu_static.tpl.php | Top and bottom menu template |
| /app/views/payment/cancel_paypal.tpl.php | Template of the page where customer is sent from PayPal if payment was canceled |
| /app/views/product/display.tpl.php | Product page template |
| /app/views/admin/ | Folder with templates used in Admin Panel |
Tips
- You can use E-commerce Site Kit as a CMS (Content Management System) for building and managing almost any kind of websites, for example as a personal online Gallery.
- If you are not going to sell anything on your website you can hide all HTML elements related to e-commerce by using CSS property visibility: hidden; applied to their CSS classes. For example: product page has a form with price and "Add to Cart" button - to hide it just put CSS property visibility: hidden; into the class .pform in the store.css file.
- You can create some product with unchecked Visible property and use it as a library of images. In this case you don't need to upload images to the site via FTP.
- Category pages can be used as a static pages - just do not put any
products to the category and use its description as a content of the
page.