Express Connect Layer
Customer Prerequisites for Installation
- It is highly preferred that the server for installation be a Linux platform.
- Install Node Version Manager (NVM):
- Install and use Node 20 with NVM
- Install Yarn:
npm install --global yarn
- Install PM2:
npm install pm2 -g
- Run each of the following commands and verify that they return the version. These commands must be recognized for the Express Connect Layer to be set up correctly. Do not skip this step.
- node -v
- yarn -v
- pm2 -v
- If on a RDP, install Visual Studio Code and Postman.
- Make the server/port accessible from outside the server.
- Provide test users with test data.
- Once the project goes live in the app, run a Publish All and a Force Logout.
Managing the Express Connect Layer
Configuration Files
The configuration files can be found in the Express Connect Layer folder, under customer-projects/{{your project’s name}}/. There are two files: (1) .dev.env and (2) .prod.env. These files contain the details for the environments. Changes can be made in them as needed. A Connect Layer restart is required after any configuration changes are made.
Starting/Stopping the Express Connect Layer
The customer is responsible for restarting the Express Connect Layer during any server reboots. The following commands can be used for this purpose:
Linux Platform
The Express Connect Layer can be stopped with the following command:
./project-shutdown.sh {{your project’s name}}
The Express Connect Layer can be started with the following command:
./project-startup.sh {{your project’s name}} {{the relevant environment name: either dev or prod}}
Windows Platform
The Express Connect Layer can be stopped with the following command:
project-shutdown.bat {{your project’s name}}
The Express Connect Layer can be started with the following command:
project-startup.bat {{your project’s name}} {{the relevant environment name: either dev or prod}}