Skip to content

carolinaborim/fuse-equipment-api

 
 

Repository files navigation

FUSE Equipment API

Build Status Code Climate License

This is an API that consumes the AGCO's Telemetry API, and exposes the Equipament information as a JSON RESTful endpoint. It is developed on top of node.js.

Executing

The API is requires node.js to be executed, and a C compiler to install some libraries with native bindings.

To start a webserver on a given port, execute the following:

npm install # Ensures that dependencies are installed
PORT=1234 npm start

The server will be running at: http://0.0.0.0:1234

Developing

The API is requires node.js to be developed.

To start the development server, you can execute:

npm install # Ensures that dependencies are installed
npm run start-dev

This will start a server listening on http://localhost:9090 and will reload the server when it noticies file changes.

The codebase contains tests, and to validate changes, you may execute:

npm install # Ensures that dependencies are installed
npm test # Triggers package analisys, lints and tests

About

A Telemetry API Façade that exposes Equipment as first-class citizens

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%