LTA Datamall Caller
NOTE: This module is still under heavy development and shouldn't be used in production!
A well-tested, object-oriented, promise-based LTA Datamall API caller written in Typescript with built-in definitions.
Installing / Getting started
This a over-engineered module that's really easy to install:
npm i lta-datamall-caller
This installs the module into your project's
- Semantic Release
It is recommended to have
nvm installed to ease switching between Node.js and NPM versions.
Ensure that Node.js 10.15 and above is installed.
Setting up Dev
Settings up a development environment is pretty simple:
git clone https://github.com/achrinza/lta-datamall-caller.git cd lta-datamall-caller/ npm i
This will clone the repository and install all the neccessary dependencies.
If your project needs some additional steps for the developer to build the project after some code changes, state them here. for example:
npm run build
This builds your code.
Deploying / Publishing
#TODO: Write publishing steps
And again you'd need to tell what the previous code actually does.
Tests are done by Jest and are written in Typescript.
#TODO: Write test examples
There's no style guide. ESLint and Prettier will fix any issues.
This project under MIT license. Refer to LICENSE for more details.