emeraldpay / emerald-api-js

Emerald API Client for Javascript

NodeJS / Electron Client

Web Client

Development

Build Instructions

Prepare Environment

yarn install

Build all

yarn workspaces run build

Build individual modules

yarn workspace @emeraldpay/api run build
yarn workspace @emeraldpay/api-node run build
yarn workspace @emeraldpay/api-web run build

Compile individual modules

yarn workspace @emeraldpay/api run build:ts
yarn workspace @emeraldpay/api-node run build:ts
yarn workspace @emeraldpay/api-web run build:ts

Test individual modules

yarn workspace @emeraldpay/api run test
yarn workspace @emeraldpay/api-node run test
yarn workspace @emeraldpay/api-web run test

Update Protobuf

This Client references Emerald API protobuf through Git Submodules. Original Protobuf definitions are located at: https://github.com/emeraldpay/emerald-grpc

Update Protobuf definitions to the latest:

git submodule update --remote
git commit api-definitions

License

Copyright 2022 EmeraldPay, Inc

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.