Install Additional Files in the Source Directory

Installing additional files in the SuiteCommerce Advanced (SCA) source directory is essential for setting up your development environment. This process ensures that all required Node.js packages are in place and that the Gulp.js tool compiles your source modules into a usable application.

Prerequisites

Before you begin, ensure that you have downloaded and extracted the SCA source directory. It is important to note that these instructions primarily apply to customizations within the Kilimanjaro release of SCA or earlier. For the Aconcagua release or later, it’s best to use themes and extensions unless your scenario requires alternative customizations.

Accessing the SCA Source Directory

1. Open a command line or terminal window.
2. Navigate to the local SCA source directory containing the package.json file.
   • For the 2020.1 release and later, use the SC_xxx directory (e.g., SC_20.1).
   • For the 2019.2 release, access the *_Live directory (e.g., SC_19.2_Live).
   • For the 2019.1 release or earlier, go to the top-level root directory (e.g., SuiteCommerce Advanced <release_name>).

Installing Additional Required Files

To install the necessary files:

1. Run the following command to install additional Node.js packages:
   bashCopy

   npm install

   This will take several minutes as it downloads the dependencies required by the developer tools.
2. Once installed, execute Gulp.js with:
   bashCopy

   gulp

   This will create a local distribution directory and compile your SCA source modules into a deployable application.

Important Notes

• If Sass Compilation Errors occur during the Gulp.js execution, you will need to manually rectify these issues. Refer to the relevant troubleshooting documentation for guidance.
• After running gulp for the first time, a local distribution folder is created:
  • For the 2020.1 release and later, this is located in SC_xxx/LocalDistributionAdvanced.
  • For the 2019.2 release, find it in *_Live/LocalDistributionAdvanced.
  • For earlier releases, check SuiteCommerce Advanced <release_name>/LocalDistribution.
• Remember to perform this installation procedure in every new SCA source directory whenever you download an updated version.
• If you have multiple copies of the SCA source directory in your environment, repeat this process for each directory.
• While NPM vulnerabilities might show in an audit, they will not affect the SCA application’s source code.

Following these steps will ensure that your SuiteCommerce setup is ready for development, allowing you to customize your application effectively.