leanix-js

A Javascript client for LeanIX

Getting Started

Install the library in your project

npm install leanix-js

Check here for usage examples.

API documentation for this library can be found here.

Running the examples

1. Install the library dependencies and build it

npm install && npm run build

2. Create a lxr.json file in the root folder of the project with the following properties:

{
  "instance": "<your leanix instance, e.g. 'app.leanix.net'",
  "apiToken": "<your api token>"
}

3. Run or debug the example file of your choice

Running the tests

1. Confirm that you have created the lxr.json file in the root folder of your project.

2. Run the command:

npm run test

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

• Paulo dos Santos - Initial work - pmrs78

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details