Upit File Handlers

File handling logic and helpers for the Configur Upit project

Installation

To install this package just do:

npm i -S @configur-tech/upit-file-handlers

If it complains, means you are probably not logged in, so run npm login and follow its instructions.

In CI you will need the NPM_TOKEN env var set

---

Local Installation

In order to run the code in this repo locally, you'll need Node.js installed (code itself was written in Node 18.13.0, but anything 18 or above should work).

1. If you don't have node installed, I would recommend doing so via Node Version Manager nvm which can be installed like so:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.0/install.sh | bash

2. Then all you need to do is install the correct version of node via:

nvm install

This detects the .nvmrc file in the repo, and installs the version specified there

3. Now that node is installed and is the right version, run the following to install all the project dependencies:

npm i

4. Can verify it all worked correctly by running the tests:

npm run test:unit

5. Ready to roll!