Welcome to the get-started guide! This guide will help you become familiar with ScandiPWA. To begin using ScandiPWA, you have two options:

You can learn more about these concepts:

How does ScandiPWA integrate with Magento?

How to use the storefront mode?

It optimizes the build for the best performance.

In Standalone storefront mode - the front-end is running on a small separate server and uses a remote Magento 2 instance as the source for the data.

<aside> ➡️ In this mode, you are not required to run Magento 2 locally to develop.

</aside>

When using this mode it is enough to have a ScandiPWA theme powered by Create ScandiPWA App(CSA) to compile it. As a data source, you can use any existing properly configured Magento 2 instance or create a ready Magento 2 instance using RMG (ReadyMage).

Storefront Mode Setup

Video: Setting up and talking theory

<aside> ⚠️ If you are deploying ScandiPWA on a production server or you would like to develop on a remote server (via SSH, for example), please follow the link below.

persisted-query cachingExisting Magento 2 setup

</aside>

How to use the Magento theme mode?

In Magento 2 theme mode - the front-end is statically compiled and served by the Magento 2 server. In this case, data comes directly from the same server the application is hosted on.

<aside> ➡️ In this mode, you are required to run Magento 2 locally to develop.

</aside>

In order to simplify the local Magento 2 installation, we recommend using the CMA (Create Magento App) toolchain, with the goal of starting a Magento 2 instance with a single command. The CSA (Create ScandiPWA App) toolchain will still be used to compile a theme.

Magento Mode Setup

If you have a not CMA existing Magento 2:

Useful resources:

Magento Commerce Cloud setup

Magento troubleshooting

How to deploy a native app?

In order to publish a PWA as a stand-alone native application requires adding extra functionality which is not available by opening PWA in a web browser. Allowing to receive push notifications, scan QR codes, and access user contacts might be such features.

Deploying Native Apps

Build & Deploy Android apps

Build & Deploy iOS app

How to update to newer releases?

How to upgrade the Magento version?

How to upgrade the ScandiPWA version?

ScandiPWA composer dependency update

Storefront mode upgrade

Magento mode upgrade

How to contribute?

Learn how to contribute to ScandiPWA.

Contributing

Installation from Fork

Repository structure

Code contribution process

Submitting an Issue

Publishing ScandiPWA

Magento Mode Setup