Start chat

CharmChara Documentation

Magento theme installation

This theme is not compatible with Magento 1.9 engine. It will work with the Magento 2.2.2 engine only.

Install Theme on Live Store

To install the theme you only need to upload all the theme files (the app folder) to your server and then enable the theme in the admin panel.

If you don't want to spend your time installing the theme, don't hesitate to order installation service using our live-chat.

But to avoid unexpected problems after installation, you should first prepare your Magento. Please strictly follow the steps described in this guide:

Attention!

Please DO NOT import sample data if you have a live website as it will completely replace your database contents, and all your website data will be LOST.

First of all, please make sure your Magento installation version meets the template requirements. The detailed Magento update guide you will find on the Magento User Guide.

*It is recommended to install the theme on a test server before you install it on a live store.

Step 1. Backup Magento files
Backup Magento files and the store database.

Important: creating backup before installation of any themes or extensions in Magento is extremely important, especially if you are working on a live store.

On the Admin sidebar, tap System. Then under Tools, choose Backups.

In the upper-right corner, tap the button for the type of backup you want to create:

System Backup-
creates a complete backup of the database and the file system. During the process, you can choose to include the media folder in the backup.
Database and Media Backup- creates a backup of the database and the media folder.
Database Backup-
creates a backup of the database.

To put the store into maintenance mode during the backup, mark the checkbox. When the backup is complete, maintenance mode is turned off automatically.

For a system backup, mark the Exclude checkbox if you do NOT want to include the media folder. Then when prompted, confirm the action.(press OK)

The backaps files stored under the var > backups folder.

In case of Error 503 DELETE the maintenance.flag file from var folder.

Step 2. Disable the cache
Disable all cache systems which you have in your Magento.

Important: when developing your Magento store, in order to be able to see changes immediately, you should completely disable the cache. You can enable it after you finish configuring your store.

    On the Admin sidebar, tap System. Then under Tools, choose Cache Management.

    Choose Select All from the Mass Action dropdown.

    Then you need to select Disable from the Action dropdown and press the Submit button.

    Do not forget to enable the cache after the theme installation and configuration.

    Step 3. Upload the app folder

    Now you need to copy the zipped content of the theme folder (the app folder) to the root folder of your online shop.

    • theme
      contains Magento theme files and directories that should be uploaded to the root directory of your Magento installation .
      • app
    Find the theme > app folder. You need to archive (.zip) the app folder to upload it to the server. Use the WinZip 9+ (for Windows) or Stuffit Expander 10+ (for Mac) to compress the app folder.

    Log into cPanel > navigate to the Files section and click on the File Manager icon.

    Once you select your directory, click on the Go button.

    Open the root folder of your online store.

    Click on the Upload icon.

    Make sure you've set the correct permissions type for the app folder. The permissions should be CHMOD 755 or 777, depending on your server configuration.

    Click on the Browse button.

    Find the app.zip. Click Open.

    Once the process is completed press on the Go Back to link.

    Step 4. Unzip the app folder

    Select the uploaded zip file and click the Extract icon

    Make sure the right folder is indicated. Press the Extract File(s) button.

    Then press the Close button and Reload the File Manager page.

    You can delete the .zip folder after unzipping.

    Step 5. Run the console

    After unzipping run the console and navigate to the root directory of your store.

    Attention!!!

    Due to the peculiarities of the engine you will have to use any console environment with the command line. Module configuration will be mainly performed via the command line. If you perform changes on the hosting server, you can contact your hosting provider for help and use the hosting command line.
  1. Run the following commands in the command line, one by one:
    1. bin/magento setup:upgrade
    2. bin/magento index:reindex
    3. bin/magento cache:clean
  2. Then follow the instructions for setting up the theme.

Template Configuration

We are going to review template configuration options based on the example. We will configure it the same way as our Live Demo template, without affecting products data.

Activate the new theme

  1. Open Magento admin panel and navigate to Content > Configuration menu.
  2. In the list of stores you need click edit at Global-Main Website. Also, you can click edit for a particular store view if you have them.
  3. In the Default Theme click Applied Theme drop-down list select the required theme, then click Save Configuration button.
  4. Reindex Magento data. See the tutorial on How to Reindex data.

Logo configuration

Please follow these steps when setting up logo image included into the theme package (you can view it on the Live Demo page).

  1. Open the Magento admin panel and select Content > Configuration in the side menu.
  2. In the list of stores you need click edit at Global-Main Website. Also, you can click edit for a particular store view if you have them.
  3. Select the "Header" tab, and upload your logo.
  4. Click "Save Config" button.

You can set the Logo via Theme Options extension.

* See the tutorial on How to upload the Logo.

Static blocks configuration

When you are done with the pages configuring, you need to configure the static blocks. The procedure is similar: you need to copy the code from the source files and paste it to the corresponding fields in the Magento admin panel. You need to use a similar table but for the static blocks.

Block ID may vary in your Magento installation. You can get correct block id from Content > Blocks section in Admin panel.

  1. In the top menu navigate to Content > Blocks.
  2. In the top right corner click the "Add New block" button to add a new static block.
  3. Specify the block name and identifier. You can get the block details from the table at the template configuration page [check the Pages Configuration part].
  4. Open the block source file and copy the HTML code into the content area.

NOTE: some templates do not contain any static blocks, so the table can be empty.

The source files with the static blocks code are stored in the "sources\demo\static_blocks\" folder of the template package.

How to display our blocks with static content?

  1. In the top menu navigate to Content > Widgets
  2. In the top right corner click the "Add Widget" button to add a new widget.
  3. Specify the widget type CMS Static Block and theme that you want to apply the widget to, then click Continue button.
  4. On the next page in the Widget Title field enter the name of the widget which will be displayed in the admin panel. In the Assign to Store Views field you need to select store views which will display the widget. In the Layout Updates block click Add Layout Update button. In the Display On field you can select pages where widget will be displayed on. Depending on selected pages you will have opportunity to fill in the additional fields.
  5. In the left sidebar click Widget Options tab and select the static block you are referring to. Don't forget to save changes.

When you are done configuring store pages and blocks, your store is ready to go.

Pages configuration

In order to make your template look exactly like our Live Demo, you need to set up store pages in a specific way. We provide all the files with the pages source code. You need to add them into Magento admin panel as per the instructions below using the settings table. Settings table is located on the Template Settings page on the template preview page.

The main template page will be affected the most. It usually contains the following elements: banners, slider, etc.

We recommend that you disable the WYSIWYG editor. To do this, from the admin top menu select Stores > Configuration. Open the "Content Management" section uncheck and in the WYSIWYG Options window set "Enable WYSIWYG Editor" option to "Disabled Completely".

In case you have already made the changes to your pages code and would like to add our code without affecting your changes, it is recommended to contact professional technicians or prepare a backup before making changes.

Template Settings

Configuration of display static blocks/widgets on different layouts shown in the table below.

Home pages configuration
# Page Name Page HTML (Content tab) Page XML (Design tab) Layout
1. Home Page sources\demo\pages\home_page.phtml NA 1 column
2. About Us sources\demo\pages\about_us.phtml NA 1 column
3. Customer Service sources\demo\pages\customer_service.phtml NA 1 column
4. Privacy Policy sources\demo\pages\privacy_policy.phtml NA 1 column
5. Shipping & Delivery sources\demo\pages\shipping-delivery.phtml NA 1 column
6. FAQ sources\demo\pages\faq.phtml NA 1 column
7. Support sources\demo\pages\support.phtml NA 1 column
8. Guarantee sources\demo\pages\guarantee.phtml NA 1 column
9. Secure payment sources\demo\pages\secure-payment.phtml NA 1 column
10. Terms & Conditions sources\demo\pages\terms-conditions.phtml NA 1 column
Static blocks configuration
# Block Name Block Title Identifier Content
1. Footer column content 2 Footer column content 2 footer_col_2 sources\demo\blocks\footer_col_2.phtml
2. Footer column content 3 Footer column content 3 footer_col_3 sources\demo\blocks\footer_col_3.phtml
3. Footer column content 4 Footer column content 4 footer_col_4 sources\demo\blocks\footer_col_4.phtml
4. Footer column 2 title Footer column 2 title footer_col_2_title sources\demo\blocks\footer_col_2_title.phtml
5. Footer column content 1 Footer column content 1 footer_col_1 sources\demo\blocks\footer_col_1.phtml
6. Banner Box Banner Box banner_box sources\demo\blocks\banner_box.phtml
7. Banners Menu Banners Menu banners_menu sources\demo\blocks\banners_menu.phtml
8. footer_info_block footer_info_block footer_info_block sources\demo\blocks\footer_info_block.phtml
Widgets configuration

# Widget Name Widget Type Block Reference Template / (Static Blocks) Sort Order
1. Banner Box CMS Block Main Content Banner Box Block 1
2. Slider FilmSlider After Page Header FilmSlider Block 1
3. New Arrivals CMS Block Main Content Featured products Block 2
4. Featured Products CMS Block Main Content Featured products Block 3
5. Shop by brands CMS Block Main Content Shop by brands 4
6. Catalog Image Grid CMS Block Main Content Catalog Image Grid 5
7. Latest News Blog Latest Posts Main Content Blog Latest Posts 6