Installing an extension
Last updated
Was this helpful?
Last updated
Was this helpful?
ScandiPWA setup considers having the back-end (Magento 2 Module) and front-end (ScandiPWA Extensions) of your application completely separated. If you are looking for back-end part instructions, refer to the link below.
Note: The following instructions are valid for ScandiPWA 4.x For 5.x, please go to https://marketplace.scandipwa.com/extension-manual-installation-guide
Download the archive containing the FE part of the extension from the marketplace.
Create a packages/
directory inside of your theme's root.
Put the archive's contents inside of the packages/<package name>
directory. Make sure that you have a packages/<package name>/package.json
file present alongside all the other extension's contents, that means that you have unpacked the extension correctly. Note: <package name>
can also include publisher, @scandipwa/paypal
is a valid package name.
Add the following scripts to the scripts
section of your theme's package.json
file. This is necessary for your package to be symlinked into the node_modules
directory of your theme after manipulations with dependencies
Add the extension to the dependencies of your theme, as follows:
Update the symlinks by running the following command
Some of the FE ScandiPWA extensions are available for installation using npm
and yarn
.
The process is different from the regular module's installation, the ScandiPWA packages are stored in our own registry - r.scandipwa.com
The installation process is the following:
Get the credentials (token) from the marketplace
Configure the token for your project
2.1. Create an .npmrc
file inside of your project's root directory, neighboring to the package.json
file. The .npmrc
file should be created even if you are using yarn
.
2.2. Put your token in there in the following format:
Add the desired package to your project's dependencies (and fetch it)
When installing your project's dependencies, don't worry about any additional actions. The yarn.lock
or package-lock.json
will contain all the necessary data
Turn on the extension in your theme's package.json
file. You may turn it off by changing true
to false
in the corresponding extensions
block's entry.
scandipwa-cli
Currently, it is possible to install the extensions published to npm
with the scandipwa-cli
package, by using scandipwa extension install
command.
It is planned to provide support for installing local extensions in the future.
More information about installing via scandipwa-cli
from npm
registry see here.