bambudocker/apex-sftp repository overview

⁠APEX SFTP Connector

The codebase here is for a REST API and CRON jobs related to the APEX SOD files.

⁠What is with the functions with the class methods # prefix?

This is to leverage ES2020 private function capabilities. This is one of the reasons this project has a minimum node version of 16.

There are still certain things that have a _ prefix to denote private as a convention. This is a legacy of pre ES2020 capabilities and should be altered when possible.

See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/Private_class_fields⁠

⁠Getting Started

To get started, make sure you have the following things installed on your system.

⁠Node version

The project has a minimum Node.js and NPM requirements. To see what version of node is required you can either check the package.json file or the .nvmrc file. It is recommended you install NVM so you can have multiple versions of Node.js running concurrently without the need to install or uninstall.

⁠NVM for *NIX Development Machines (Linux/Mac OS)

To set your current NVM version, you can simply run the following command.

nvm use

This will set your NVM version.

⁠NVM for Windows Development Machines (10/11)

Windows NVM does not support the use of .nvmrc directly. To work around this, a PowerShell script was written. You can trigger it by simply running the following command in your PowerShell terminal:

.\nvmrc-windows.ps1

This will set your NVM version. Note that some prompts may come asking to run some commands. That is expected.

⁠Setting Up Development Environment

There are NPM run scripts to trigger development runs. The NPM run scripts have a suffix of :devl. These rely on env-cmd which require a .env-cmdrc.js file to configure the environment variables. To see the sample setup, you can create the .env-cmdrc.js file based on the template found in .env-cmdrc.template.js.

⁠Create tmp Folder - Windows Only

Windows does not have /tmp by default unlike Linux which this will be deployed to. To overcome this, simply create the folder tmp in the root directory of the Windows Drive you are in. For instance if your code is located at C:\devl\bambu, create the directory C:\tmp.

⁠Husky Fix - Linux Only

You will need to run the following commands:

chmod ug+x .husky/*

chmod ug+x .git/hooks/*

Not doing this can lead to your Git pre-commit hooks to be inoperative.