# Installation

## Overview

The `create-scandipwa-app` setup considers having BE and FE of your application completely separated.

When you purchase an extension, you get access to all of its parts - both BE and FE. The BE part should be handled just as any other installable module for BE of your choice (e.g. Magento 2).

The frontend part of an extension is a regular node module with structure and contents dictated by the `create-scandipwa-app` plugin system.

## Install from a local source

1. Download the archive containing the FE part of the extension from the marketplace.
2. Create a `packages/` directory inside of your theme's root.
3. 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.
4. 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

   ```javascript
   {
       "scripts": {
           "postinstall": "scandipwa-scripts link",
           "postupdate": "scandipwa-scripts link"
       }
   }
   ```
5. Add the extension to the dependencies of your theme, as follows:

   ```javascript
   {
       "dependencies": {
           "<package name>": "file:packages/<package name>"
       }
   }
   ```
6. Update the symlinks by running the following command

   ```bash
   # For yarn users
   yarn postinstall

   # For npm users
   npm run postinstall
   ```
7. [Enable the extension](#enable-the-extension)

## Install with a package manager (beta)

Some of the FE ScandiPWA extensions are available for installation using `npm` and `yarn`.

The process is a 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:

1. Get the [credentials](https://marketplace.scandipwa.com/scandipwa_npmregistry/index/auth/) (token) from the [marketplace](https://marketplace.scandipwa.com/)
2. 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:

   ```bash
   TOKEN=put.token.here
   //r.scandipwa.com/:_authToken=$TOKEN
   ```
3. Add the desired package to your project's dependencies (and fetch it)

   ```bash
   # Write a full command
   yarn --registry https://r.scandipwa.com add <package>
   npm --registry https://r.scandipwa.com i <package>

   # Or create an alias
   alias yr='yarn --registry https://r.scandipwa.com'
   alias npr='npm --registry https://r.scandipwa.com'

   # and use it
   yr add <package>
   npr i <package>
   ```
4. 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

   ```bash
   # For yarn users
   yarn

   # For npm users
   npm ci
   ```
5. [Enable the extension](#enable-the-extension)

## Enable the extension

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.

```javascript
    {
        "scandipwa": {
            "extensions": {
                "<package name>": true
            }
        }
    }
```

## Install by using `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](https://docs.create-scandipwa-app.com/extensions/extensions).