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:
- create a new branch and make your updates to the code in the branch (avoid changing the
masterbranch directly); - do your own quality assurance;
- update the documentations(Please refer to How to update documentation page for more information);
- update the unit tests (if applicable);
- make sure there are no warnings or errors from static analysis programs
(
make allshould be free of warnings and errors); - make sure you can deploy your code without any issues (
make dist && make deployshould not fail); - make sure that all tests are passing before submitting the request (
make testshould be free of errors); - make your pull request, assign it to yourself, and ask someone to review your code.
- Try to provide as much information as you can on your PR. Explain the issues that the PR is fixing and the changes that you've made in the PR.
- Provide examples if applicable.
- Resolve the conflicts with the
masterbefore 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.