Install Additional Files in the Source Directory

Important:

These topics refer to customizations of the Kilimanjaro release of SuiteCommerce Advanced (SCA) or earlier. If you are implementing the Aconcagua Release of SCA or later, the best practice is to use themes and extensions to customize your site unless your customizations require access to objects not available using the Extensibility API.

After downloading and extracting the SCA source directory, complete the following steps to finish installing the developer tools.

Note:

You must run all commands in the SCA directory where the package.json file is located.

• If implementing the 2020.1 release or later, this directory is the SC_xxx directory within your root source directory. For example: SC_20.1

• If implementing the 2019.2 release, this directory is the *_Live directory within your root source directory. For example: SC_19.2_Live

• If implementing the 2019.1 release or earlier, this directory is the top-level root directory. For example: SuiteCommerce Advanced <release_name>

To install additional required files:

1. Open a command line or terminal window.

2. Access the local SCA source directory that contains the package.json file.

3. Install additional Node.js packages by running the following command:

   npm install

   This command may take several minutes to install the dependencies required by the developer tools.

4. Run Gulp.js using the following command:

   gulp

   Running Gulp.js creates the local distribution directory and compiles SCA source modules into a deployable application.

Note the following:

• If you encounter Sass Compilation Errors when running Gulp.js, you need to manually correct the compilation errors. For more information, see Troubleshooting the Developer Tools.

• The first time you run the gulp command, the developer tools create a local distribution folder that contains the combined SCA application. After the command completes successfully, you see the new folder at the following location:

  • If implementing the 2020.1 release or later, the LocalDistributionAdvanced folder is created in the SC_xxx directory within your root source directory. For example: SC_20.1/LocalDistributionAdvanced

  • If implementing the 2019.2 release, the LocalDistributionAdvanced folder is created in the *_Live directory. For example: SC_19.2_Live/LocalDistributionAdvanced

  • If implementing the 2019.1 release or earlier, the LocalDistribution folder is created at the top level of the SCA source directory. For example: SuiteCommerce Advanced <release_name>/LocalDistribution

• Each time you download a new version of the SCA source files, you must perform this procedure in each new source directory.

• If you have multiple copies of the SCA source directory in your development or test environment, you must run this procedure in each of those directories.

• If you notice any NPM vulnerabilities related to an NPM audit, these vulnerabilities will not impact source code in the SCA application.

Related Topics

Set Up SCA Developer Tools

Before You Get Started

Download SCA Source Files

General Notices