Setting up a Cordova project

Complete the instructions to set up a Cordova project.

Before you begin

As a prerequisite, set up an environment to create a hybrid application by using Apache Cordova by performing the following steps:

Make sure that Sterling Store Engagement is installed.
Download and install Node.js version 16.14.0. For more information, see nodejs documentation.
Install the Apache Cordova version 12.0.0. For platform-specific instructions, see Cordova documentation.
Install platform-specific tools. For example, Xcode for iOS platform and Android SDK for android platform.

Procedure

Create a workspace folder as the command that follows.
cd <cordova_project_container_folder>
Create a Cordova project by running the command that follows.
For example, cordova create StoreAppDemo com.ibm.isf.StoreAppDemo StoreAppDemo
```
cordova create <project_name> <package_name> <folder_name>
```
```
cordova create StoreAppDemo com.ibm.isf.StoreAppDemo StoreAppDemo
```
Install iOS and Android SDK platforms and run the appropriate commands.
- For iOS, run the command that follows.
```
cordova platform add ios
```
- For Android, run the command that follows.
```
cordova platform add android
```
Install the Cordova plug-ins by running the appropriate commands.
- If you are on version <4.5.0, install the Cordova plug-in device by running this command.
```
cordova plugin add cordova-plugin-console
```
- Install the peripheral device plug-ins.
- If necessary, install the base plug-ins. For more information, see Cordova Plugins.
Modify the Cordova config.xml file that is present in <project_folder>.
1. Install cordova-plugin-inappbrowser only if you have enabled OIDC authentication for Store UI. In the Cordova plugin add cordova-plugin-inappbrowser.
2. Set the value of src attribute in the content element to point to the application URL.
  For example, <content src="http://localhost:9080/isf/store-frontend/index.html"/>
3. Update the following elements to allow the application to access the URLs:
```
<allow-navigation href="http://*/*" />
<allow-navigation href="https://*/*" />
<allow-intent href="http://*/*" />
<allow-intent href="https://*/*" />
```
4. Set an appropriate value for the AppendUserAgent attribute to load platform-specific Cordova plug-ins as follows:
  <preference name="AppendUserAgent" value="< >" />. For example, <preference name="AppendUserAgent" value="cordova-ios" />.
5. If specified by the plug-ins provided by peripheral-device vendors, configure the project settings.
6. Complete any additional instructions that are provided by the plug-ins that you installed.
Build and deploy the application on the appropriate device. For more information, see the following resources: