Flipbook

Magento 2 Extension — User Guide & Documentation

Magento 2.3.x / 2.4.xBy MagepowAdmin + Frontend
Vendor
Magepow Extensions
Online docs
docs.magepow.com

1 · Installation

Two ways to install — via Composer or by uploading the app folder. Both end with the same Magento CLI steps.

Before you begin: install the extension on a staging/test server first, and take a full backup of your files and database — especially on a live store.

System requirements

  • Magento 2.3.x / 2.4.x installed and working
  • PHP, MySQL/MariaDB and web server meeting Magento 2 system requirements
  • SSH access to run Magento CLI commands

Method 1 — Install via Composer (recommended)

  1. Open a terminal in your Magento 2 root directory and require the package:
    composer require magepow/flipbook
  2. Run the Magento setup upgrade:
    php bin/magento setup:upgrade
  3. Deploy static content (production mode):
    php bin/magento setup:static-content:deploy -f
  4. Flush the cache:
    php bin/magento cache:flush

Method 2 — Manual install (upload app folder)

  1. Download the extension package and unzip it. Upload the app folder to your Magento 2 root so it merges with the existing app directory.
  2. Run the following commands from the Magento 2 root:
    php bin/magento setup:upgrade
    php bin/magento setup:static-content:deploy -f
    php bin/magento cache:flush
  3. Log out of the Admin panel and log back in to refresh access permissions, then clear the cache under System > Cache Management.
Tip: while configuring the store, disable full-page and additional PHP caches (Varnish, Redis, OPcache/APCu) so changes appear immediately. Re-enable them when you are done.

2 · Configuration & Usage

All settings live in the Magento Admin panel. Screenshots below match the default Admin theme.

1 - How to configure the extension

General Configuration

To Enable/DisableMagepow Flipbook Extension: Go to Admin Panel > Stores > Settings > Configuration > Magepow > Flipbook. Then, select Yes to Enable module/No to Disable the module

enable disable

2 - How does Flipbook extension work?

After enabling the module, we will configure the Flipbook module. InAdmin Panel > Stores > Settings > Configuration > Magepow > Flipbook > Add New Book

2.1 Add new book

addbook

  • Name: The title of the book you want to add.
  • Thumbnail: Add image file to your book.
  • Book: Add book file that you want to add here as a file pdf.
  • Author: Add author your book.
  • Description: Describe the plot of the book.

2.2 Add new widgets

In Magento Admin > Content > Widgets > Add Widget > Setting > Setting type and design theme > Continue.

widget

Add widget title, assign store views, sort order and in layout updates to display on pages the example shown below.

settingwidget

Results in frontend

On the web page click on the picture of the book being displayed on the installed page.

widgetstorefront

result front

We can also query the URL on this link to display all created flipbooks.

3 · Support

Found a bug or need customization? Contact us — we usually reply within 24–48 hours.

Need help?

Bug reports

If you find a bug, please report it via the ticket system with steps to reproduce, expected vs. actual behavior, and any relevant logs (var/log/system.log, var/log/exception.log).