ermrestjs v0.0.1

ERMrestJS -- ERMrest client library in JavaScript

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 (ER) concepts that are native to ERMrest. The library has been extended to also support Hatrac---an object store service, and ioboxd---an export service. ERMrestJS is a part of Deriva Platform.

Documention

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 on how you can configure and use ERMrestJS.

Prerequisites

As described, ERMrestJS is providing a Javascript API to ERMrest, Hatract, and iboxod. Therefore, to use this API you need those services to be available in your server.

Installation

See ERMrestJS installation.

Usage

ERMrestJS can be used in browser, nodeJS, or AngularJS environments. See ERMrestJS usage for more detail.

Code 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 (avoid changing master branch directly);
2. do your own quality assurance;
3. update the documentations(Please refer to How to update documentations 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 install 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 done in the PR.
• Provide examples if applicable.
• Resolve the conflicts with master before merging the code (and go through the process of making sure 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 group at the USC Information Sciences Institute.