Skip to content

JS + Flow implementation of Panthalassa, the Pangea backend.

License

Notifications You must be signed in to change notification settings

Bit-Nation/BITNATION-Pangea-libs

Repository files navigation

Pangea Libs

A Javascript + Flow implementation of the pangea utils

Build Status Coverage Status

Documentation

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.

Development

We are using docker for development.

  1. Get docker
  2. Run docker-compose up -d
  3. Run docker-compose exec node bash
  4. Within the docker image's shell, you may run npm install to set up the dependencies, and npm test to test the project.

Troubleshooting

Problem: Test suite fails to run with TypeError: Cannot redefine property: Worker

Fix: See #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 develop branch.