The ERMrestJS is a javascript client library for interacting with the ERMrest service. It provides higher-level, simplified application programming interfaces (APIs) for working with the Entity-Relationship concepts native to ERMrest.
The library has been extended to also support Hatrac (an object store service), and deriva-web export. ERMrestJS is a part of Deriva Platform.
As described, ERMrestJS provides a Javascript API to ERMrest, Hatract, and deriva-web export. Therefore, you need those services to be available on your server to use this API.
ERMrestJS can be used in the browser, nodeJS, or AngularJS environments. See ERMrestJS usage for more detail.
Documents are categorized based on their audience.
Developer Docs: contains API docs and development guides such as how to write unit tests.
User Docs: contains documents and examples of configuring and using ERMrestJS.
When developing new code for ERMrestJS, please make sure you're following these steps:
master
branch directly);make all
should be free of warnings and errors);make dist && make deploy
should not fail);make test
should be free of errors);master
before merging the code (and make sure documentation and tests are good to go).Please direct questions and comments to the project issue tracker at GitHub.
ERMrestJS is made available as open source under the Apache License, Version 2.0. Please see the LICENSE file for more information.
ERMrestJS is developed in the Informatics Systems Research group at the USC Information Sciences Institute.