Installation instructions

https://r.scandipwa.comThis is the recommended way of theme installation. This type of installation prohibits you to modify package source, and enables upgrades via NPM.

1. Make sure you have an NPM token generated in My Account / NPM Auth tokens section of the marketplace

2. Find the package name matching your theme in My Account / NPM packages section of the marketplace

3. Create the .npmrc file with the following contents, inside of your ScandiPWA root folder:
   
   //r.scandipwa.com/:_authToken=<NPM_AUTH_TOKEN>
   @scandiweb:registry=https://r.scandipwa.com/
   always-auth=true
   

4. Copy the NPM auth token, and replace the <NPM_AUTH_TOKEN> template in .npmrc with your NPM token

5. Add the themes package to your project's dependencies, use one of the commands:

   1. You can use Yarn: yarn add <PACKAGE>

   2. Or use NPM: npm i <PACKAGE>

6. Change the scandipwa.parentTheme field in ScandiPWA root package.json to be equal to theme’s package name, for example, @scandiweb/my-theme
7. Run your theme as usual, it should start and have a new desired appearance of your new theme

This type of installation enables you to modify package source, but prevents further upgrades.

1. Create (or make sure it exists) packages folder inside of your ScandiPWA root
2. Download the package from My Account / My Downloadable Products section of the marketplace
3. Unzip package into newly created folder
4. Make sure the package.json file is found in packages/<UNZIPPED FOLDER>, for example, packages/my-theme/package.json
5. Copy the name field from themes package.json file
6. Edit the ScandiPWA root package.json to include the package name as dependency, in versions place specify relative path to the theme’s root prefixed with file: for example, file:./packages/my-theme. In the end dependencies field in the package.json must include similar entry: "@scandiweb/my-theme": "file:./packages/my-theme"
7. Make sure the ScandiPWA root package.json includes "postinstall": "scandipwa-scripts link", and "postupdate": "scandipwa-scripts link" entries in the scripts field
8. Change the scandipwa.parentTheme field in ScandiPWA root package.json to be equal to theme’s package name, for example, @scandiweb/my-theme
9. Install dependencies, use one of the commands:
   
   
   1. You can use Yarn: yarn
   2. Or use NPM: npm i
10. Run your theme as usual, it should start and have a new desired appearance of your new theme

This is the recommended way of extension installation. This type of installation prohibits you to modify package source, and enables upgrades via NPM.

1. Make sure you have an NPM token generated in My Account / NPM Auth tokens section of the marketplace
2. Find the package name matching your extensions in My Account / NPM packages section of the marketplace
3. Create the .npmrc file with the following contents, inside of your ScandiPWA root folder:
   
   //r.scandipwa.com/:_authToken=<NPM_AUTH_TOKEN>
   @scandiweb:registry=https://r.scandipwa.com/
   always-auth=true
   
4. Copy the NPM auth token, and replace the <NPM_AUTH_TOKEN> template in .npmrc with your NPM token
5. Add the extensions package to your project's dependencies, use one of the commands:
   
   
   1. You can use Yarn: yarn add <PACKAGE>
   2. Or use NPM: npm i <PACKAGE> 
6. Change the scandipwa.extensions field in ScandiPWA root package.json to include extensions enablement entry, for example: "@scandiweb/my-extenion": true
7. Run your app as usual, it should start and have a an extension functionality enabled

This type of installation enables you to modify package source, but prevents further upgrades.

1. Create (or make sure it exists) packages folder inside of your ScandiPWA root
2. Download the package from My Account / My Downloadable Products section of the marketplace
3. Unzip package into newly created folder
4. Make sure the package.json file is found in packages/<UNZIPPED FOLDER>, for example, packages/my-extension.
5. Copy the name field from extensions package.json file
6. Edit the ScandiPWA root package.json to include the package name as dependency, in versions place specify relative path to the extensions root prefixed with file: for example, file:./packages/my-extension. In the end dependencies field in the package. json must include a similar entry: "@scandiweb/my-extenion": "file:./packages/my-extension"
7. Make sure the ScandiPWA root package.json includes "postinstall": "scandipwa-scripts link", and "postupdate": "scandipwa-scripts link" entries in the scripts field
8. Change the scandipwa.extensions field in ScandiPWA root package.json to include extensions enablement entry, for example: "@scandiweb/my-extenion": true
9. Install dependencies, use one of the commands:
   
   
   1. You can use Yarn: yarn
   2. Or use NPM: npm i
10. Run your app as usual, it should start and have a an extension functionality enabled

This is the recommended way of extension installation. This type of installation prohibits you to modify package source, and enables upgrades via Composer.

1. Make sure you have an username and password generated in My Account / Composer Auth tokens section of the marketplace (if there are multiple – you can use any of the provided ones)
2. Find the package name matching your theme in My Account / Composer packages section of the marketplace
3. Run the following command from Magento 2 root folder: composer config repositories.scandipwa composer https://marketplace.scandipwa.com/media/repo
4. Update the Composer auth object (in auth.json file in your Magento 2 root or the COMPOSER_AUTH environment variable) with the following entry, while replacing the <USERNAME> and <PASSWORD> template with accoring values from step 1:
   
   "marketplace.scandipwa.com": {
       "username": "<USERNAME>",
       "password": "<PASSWORD>"
   }
5. Install the Magento module using the following command: composer require <PACKAGE>, for example composer require @scandipwa/magento-extension
6. Run magento setup upgrade scripts command: magento se:up
7. Your module should be now installed and running

This type of installation enables you to modify package source, but prevents further upgrades.

1. Create (or make sure it exists) packages folder inside of your Magento root
2. Download the package from My Account / My Downloadable Products section of the marketplace
3. Unzip package into newly created folder
4. Make sure the composer.json file is found in packages/<UNZIPPED FOLDER>, for example, packages/my-module.
5. Run the following command from Magento 2 root folder: composer config repositories.my_module path ./packages/my-module
6. Install the Magento module using the following command: composer require <PACKAGE>, for example composer require @scandipwa/magento-extension
7. Run magento setup upgrade scripts command: magento se:up
8. Your module should be now installed and running