Ocean-js

JavaScript client library for Ocean Protocol oceanprotocol.com

This is in alpha state and you can expect running into problems. If you run into them, please open up a new issue.

Table of Contents

• Get Started
  • Local development
• Testing
  • Code Linting
• Packages
• Documentation
• Contributing
• Prior Art
• License

Get Started

TBD

Local development

As a pre-requisite, you need:

• Node.js
• npm

Note: For MacOS, make sure to have node@10 installed.

Clone the project and install all dependencies:

git clone git@github.com:oceanprotocol/ocean-js.git
cd ocean-js/

# install packages
npm i

Testing

Run tests with

# for unit tests
TBD

# for test coverage
TBD

Code Linting

Linting is setup for JavaScript with ESLint

# to check lint issues
npm run lint

Code style is enforced through the CI test process, builds will fail if there're any linting errors.

Documentation

• Release process
• Core Documentation
• Packaging of libraries

Contributing

See the page titled "Ways to Contribute" in the Ocean Protocol documentation.

Prior Art

This project builds on top of the work done in open source projects:

• OpenZeppelin/openzeppelin-contracts

License

Copyright 2018 Ocean Protocol Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.