Beacon

This software is currently under heavy development. If you like to stay updated and follow the development, you can track https://blog.ntzwrk.org/tags/beacon/ or track the develop branch.

---

Beacon is a transparent and secure voting software powered by Blockstack's software stack. It lets you issue votes into a blockchain and other users vote on that.

Because of Blockstack's properties the app works completely decentralized without having to trust anyone. Beacon uses decentral naming, identity and storage as provided by blockstack.js.

Developing

If you don't have already, you need to install yarn.

Clone this repository and go into the new folder:

$ git clone https://github.com/ntzwrk/beacon
$ cd beacon

Then install all necessary dependencies with:

$ yarn install

That's it, you have set up the repository and are able to run the following commands.

Start development environment

$ yarn dev

Run tests

$ yarn test

Generate documentation

$ yarn document

Contributing

Great to hear!

If you'd like to contribute code, please raise it against the develop branch (and if you're familiar with git-flow you're welcome to use it). If you change backend code that's in the documentation, please re-create it with yarn document.

If you're not a developer but like to contribute anyway, you can help by testing the software, finding and reporting bugs, and of course spreading the word.

License

This code is published under the GNU General Public License v3.0.