@harbourproject/protocol

Harbour protocol core contracts

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@harbourproject/protocol
Minified + gzip package size for @harbourproject/protocol in KB

Readme

Harbour Protocol

Build Status License

Harbour is a protocol designed to make governance easy through modularized infrastructure that defines a set of base rules tailored to specific types of organizations. This repository contains the smart contracts for the Harbours on-chain protocol.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installing

The Harbour Protocol uses npm to manage dependencies, therefore the installation process is kept simple:

npm install

Running tests

The Harbour Protocol uses truffle for its ethereum development environment. All tests can be run using truffle:

truffle test

Using the report argument will enable the ethereum gas reporter, this prints all gas used by functions:

truffle test --report

To run linting, use solium:

solium --dir ./contracts

Built With

  • Truffle - Ethereum development environment

Authors

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

Versioning

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

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.