0.9.4 • Published 4 years ago
ngx-relevance v0.9.4
Relevance.io Angular SDK
This software development kit aims to provide a standard interface to connect to the Relevance.io APIs in Angular applications.
Getting started
Requirements
These are the general requirements for using this package:
- Node 12 or higher is recommended
- npm 6.14 or higher is recommended
- Angular 9+
- Relevance.io TypeScript SDK (
relevance-libs
)
Installation
Since this is a standard npm package, install with:
npm install
If pulling from the public repositories, run:
npm install ngx-relevance
Don't forget to install the SDK:
npm install relevance-libs
Building
The distribution can be built using the standard scripts:
npm run build
Testing
The setup.py
script provides commands to test the code before distributing it. Run
them with:
npm run test # runs the tests/ directory
npm run lint # validates code syntax
License
This code and its documentation is provided under the MIT License, bundled as the LICENSE
file. All original rights are reserved to Relevance.io 2020-.