Skip to content

README.md

Latest commit

 

History

History
40 lines (25 loc) · 1.76 KB

README.md

File metadata and controls

40 lines (25 loc) · 1.76 KB
Raw

Amonamarth Examples (English)

Field Control ♥ GitHub Super-Linter

🌋 Amon Amarth, the public supplier management API, is a REST web service that exposes resources to make it easier for companies to integrate with their other systems.

This is an auxiliary repository containing code snippets and usage examples. This is the English version of the examples. For the Portuguese version, see pt/README.md. For the Spanish version, see es/README.md.

Prerequisites to run the project

  • Node.js version manager. If you do not have nvm, install it following these steps

  • Clone this repository locally git clone https://github.com/LeoFalco/amonamarth-examples.git

  • In the project folder run the following commands

    nvm install # to install node
nvm use # switch to the installed Node.js version
npm install # install the project dependencies

  • The project uses API key authentication. You can declare yours inside a file called .env as shown in the image:

    image

Running files

The English example files are in the en/examples folder. You can run them directly with Node.js

  node en/examples/maintenances/create-maintenance-with-attachment.js

The shared code (HTTP client and utilities) lives in the core folder at the root of the repository.