Giter Club home page Giter Club logo

beacon's Introduction

Beacon

Travis Build Status

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.

beacon's People

Contributors

vsund avatar vbrandl avatar

Watchers

Sudesh avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.