README.md

stackk-community-server

The community server for stackk

Instalation

Main packages, which this project depends from:

• koa2 HTTP framework for all HTTP related operations
• mongoose for working with MongoDB database
• bch-js for BCH signatures sign and verify

yarn install

Testing

Testing is implemented via mocha testing framework. chai BDD / TDD assertion library is used in the tests.

In order to test signing requests, a wallet with some addresses in it need to be created. The default is 10 addresses:

yarn test:wallet

This command will also create .env.test file with the first address in the wallet as a moderator address for the tests.

To run all the tests:

yarn test

Using

Default server settings:

• development env
• listening on port 5000

Server can be started in other environment via KOA_ENV environment variable:

KOA_ENV=production yarn start

Port and moderator address can be set via STAKK_PORT and STAKK_MODERATOR environment variables.

Other server settings (database etc.) can be changed for every environment in config/env/ directory.

yarn start

TODO

• checking user requests signatures (moderator requests checks are done)
• documentation via asciidoc