Installing Additional Files in SuiteCommerce Advanced

TL;DR Opening

This guide details the steps necessary to install additional files in the SuiteCommerce Advanced (SCA) source directory, a vital process for developers working with SCA customizations. Following the outlined procedures ensures a smooth setup of development tools and dependencies needed for your projects.

Steps to Install Additional Required Files

Once you have downloaded and extracted the SuiteCommerce Advanced (SCA) source directory, you can complete the installation of the developer tools by performing the following steps:

Preparation

1. Open a Command Line or Terminal: Launch your command line interface to input the necessary commands.
2. Access the SCA Source Directory: Navigate to the local SCA source directory where the package.json file is located.
   • For implementations of the 2020.1 release or later, this should be within the SC_xxx directory of your root source directory (e.g., SC_20.1).
   • For the 2019.2 release, you will find it in the *_Live directory (e.g., SC_19.2_Live).
   • For the 2019.1 release or earlier, it is at the top level of the source directory (e.g., SuiteCommerce Advanced <release_name>).

Installation Process

3. Install Node.js Packages: Execute the following command to install the required Node.js packages:
   bashCopy

   npm install

   This command will take some time as it retrieves the necessary dependencies for the developer tools.
4. Run Gulp.js: After the Node.js packages have been installed, run the following command:
   bashCopy

   gulp

   This command initiates the creation of the local distribution directory and compiles the SCA source modules into a deployable format.

Notes on Running Gulp.js

• If you encounter any Sass Compilation Errors while running Gulp.js, you will need to resolve those manually. Further troubleshooting can be done by reviewing the designated troubleshooting documentation.
• The execution of gulp for the first time will generate a local distribution folder containing the combined SCA application. The location of this folder varies based on the release version:
  • For 2020.1 or later: The folder is located at SC_20.1/LocalDistributionAdvanced.
  • For 2019.2: It is found at SC_19.2_Live/LocalDistributionAdvanced.
  • For 2019.1 or earlier: Look for it at SuiteCommerce Advanced <release_name>/LocalDistribution.

Important Considerations

• Each time you download a new version of the SCA source files, repeat this procedure in the newly structured source directory.
• If you maintain multiple versions of the SCA source directory in your development or test environments, ensure this installation procedure is followed in each respective directory.
• Any NPM vulnerabilities flagged via an NPM audit will not affect the source code in the SCA application, so they can be addressed separately.

Key Takeaways

• Accessing the correct directory based on the SCA release version is crucial for successful installation.
• Running npm install and gulp is essential for setting up the development environment.
• Manual resolution may be required for compilation errors encountered during the Gulp execution.

By following these guidelines, developers can effectively manage additional file installations within SuiteCommerce Advanced to enhance their eCommerce solutions.