developing.md

Developing the Data Union join server

This section is intended for the developers of this software, not users of this software.

Foreword

This project uses Makefile instead of the usual package.json scripts. Firstly, this is done to ensure correct versions of Node and npm. Secondly, to allow dependencies between recipes.

Nvm is used to install Node and npm. Node version is specified in .nvmrc.

Common Commands

Install dependencies from package.json to get started

make npm-ci

Run unit tests

make test

Then run Data Union Join Server

make run

Run eslint

make eslint

Run eslint with fix option

make eslint-fix

Run clean

make clean

Run help

make help

API

• NodeJS 16.x
• @dataunions/client 3.x
• @streamr/config 2.x
• Express 5.x
• Commander.js
• Ethers API 5.x
• Pino API 8.x

Testing

• Mocha
• Chai
• Supertest