See here for the documentation. If you have question's create an issue for it. Feel free to have a look at the code as well since we are are heavely using JsDoc.
We are using docker for development.
- Get docker
docker-compose up -d
docker-compose exec node bash
- Within the docker image's shell, you may run
npm installto set up the dependencies, and
npm testto test the project.
Problem: Test suite fails to run with
TypeError: Cannot redefine property: Worker
Fix: See https://github.com/Bit-Nation/BITNATION-Pangea-libs/issues/55 for a deep dive into this issue. This is caused from a faulty version of realm installed locally. Version 2.1.1 of realm must be used in order to avoid this. This is believed to be fixed as of 2/7/2018 in the