ERMrestJS

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.

Prerequisites

As described, ERMrestJS provides a Javascript API to ERMrest, Hatrac, and deriva-web export. Therefore, you need those services to be available on your server to use this API.

Installation

See ERMrestJS installation.

Usage

See ERMrestJS usage.

Resources

Documents are categorized based on their audience.

• User Docs: contains documents and examples of configuring and using ERMrestJS, most notably the annotation guide.

• Developer Docs: contains development guides such as how to write unit tests.

How to Contribute

When developing new code for ERMrestJS, please make sure you're following these steps:

1. create a new branch and make your updates to the code in the branch (follow DO NOT change master branch directly and ensure your commit messages follow the convetions described here);
2. do your own quality assurance;
3. update all relevant documentation (Please refer to this page for more information);
4. update the unit tests (if applicable);
5. make sure there are no warnings or errors from static analysis programs (make all should be free of warnings and errors);
6. make sure you can deploy your code without any issues (make dist && make deploy should not fail);
7. make sure that all tests are passing before submitting the request (make test should be free of errors);
8. 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 master before merging the code (and ensure documentation and tests are good to go).

Help and Contact

Please direct questions and comments to the project issue tracker at GitHub.

License

ERMrestJS is made available as open source under the Apache License, Version 2.0. Please see the LICENSE file for more information.

About Us

ERMrestJS is developed in the Informatics Systems Research group at the USC Information Sciences Institute.