dms-s3-utilities-demo v1.0.3

Npm Library for DMS

This Npm Library is created for consumer to upload, download and archive file with dms solution efforlessly. gts is used for typescript style setting.

Publish module

Currently used personal npm account and the package is named dms-s3-utilities-demo which avoid mess up with actual package publish officially.

To publish on your own account:

1. Create a npm account -> here
2. Open terminal under project folder, Run npm login, then input username, password and email.
3. Modify name and version in package.json
4. In terminal under project folder, Run npm publish

Pack module locally and install

It is possible to pack the library locally.

1. Run npm pack
2. A *.tgz file will be generated

To install the package locally: ( Ref ) Run npm install {**/*.tgz}

Add .env file

The .env file current is setting of lambda's endpoint and api key.

To add a .env file:

1. copy and rename .env-sample to .env
2. fill up endpoints and api key

Run tests

1. add .env file
2. Run npm run test

Examples

Examples of consuming the npm library to perform dms function are in "example" folder.

Start the example:

1. add .env file under folder "example"
2. Run npm install
3. Run npm start

Useful command

• Run test: npm run test
• Lints and checks for formatting problems: npm run lint
• Compile from typescript to .js and d.ts: npm run compile
• Automatically fixes formatting and linting problems (if possible): npm run fix
• Removes output files: npm run clean
• Run clean > fix > test > compile npm run all
• Install dependencies npm install
• Pack package npm pack