dappctrl

README

Privatix Controller

Privatix Controller is a core of Agent and Client functionality.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Install prerequisite software if it's not installed.

• Install Golang 1.12+ . Make sure that $GOPATH/bin is added to system path $PATH.

• Install PostgreSQL.

• Install gcc.

Installation steps

Clone the dappctrl repository using git:

git clone https://github.com/Privatix/dappctrl.git
cd dappctrl
git checkout master

Build dappctrl package:

/scripts/build.sh

Prepare a dappctrl database instance:

/scripts/create_database.sh

Make a copy of dappctrl.config.json:

cp dappctrl.config.json dappctrl.config.local.json

Modify dappctrl.config.local.json if you need non-default configuration and run:

/scripts/run.sh

For developing purposes, you have to use dappctrl-dev.config.json.

More information about dappctrl.config.json: config fields description.

Tests

To run the tests execute following script:

/scripts/test.sh

Excluding specific tests from test run

It's possible to exclude arbitrary package tests from test runs. To do so use a dedicated build tag. Name of a such tag is composed from the no-prefix, name of the package and the test suffix. For example, using noethtest tag will disable Ethereum library tests and disabling novpnmontest will disable VPN monitor tests.

Example of a test run with the tags above:

go test $DAPPCTRL/... -p=1 -tags="noethtest nojobtest" -config=$LOCAL_CONF_FILE

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• ababo
• furkhat
• dzeckelev

See also the list of contributors who participated in this project.

License

This project is licensed under the GPL-3.0 License - see the COPYING file for details.