kkomelin / marrysign

MarrySign (Backend/Blockchain)

MarrySign (Backend/Blockchain)

MarrySign app allows any couple regardless of time, location, culture or gender to get married online. Our marital agreements are stored on Blockchain, which makes them indestructible and verifiable.

Configuration

See kkomelin/marrysign/.example.env for reference.

Copy .example.env to .env and update the variables with your values.

Installation

Please note only NPM is supported at the moment.

npm install

Test

Run automated tests:

npm run test

Run automated tests and estimate Gas consumption:

npm run test:gas

Run automated tests and calculate coverage:

npm run test:coverage

Run test network

npm run network

Compile and deploy the contract to the test network

npm run compile
npm run deploy

Code documentation

The auto-generated code documentaiton is here

Bugs, typos and suggestions

You're very welcome with your bug reports and suggestions here in the issue queue, or just drop Konstantin a line on Twitter @kkomelin.