Pyxels / SimpleVote

Simple POC Blockchain voting program using a React frontend and ethereum contract.

SimpleVote

Secure and verifiable voting powered by blockchain.
Explore the repo »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Disclaimer
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contact
6. Acknowledgments

About The Project

For a university course, we created a simple Voting application which can be hosted on an ethereum blockchain, along with a frontend to interact with this smart contract. This application offers any user to create their own VoteRoom to which any address can be invited. The owner of a VoteRoom can create private votes in which only the invited voters can vote, or create public votes which are open to any user with sufficient funds.

(back to top)

Built With

• Next.js
• React.js
• Ethereum
• Node.js

(back to top)

Disclaimer

⚠️ This is a simple proof-of-concept university project and should not be used in any real world application.

Getting Started

Prerequisites

• npm
• Node.js
• Metamask

Installation

1. Pull the repo
2. Move into the directory

cd SimpleVote/

3. Install all dependencies

npm install
npm run postinstall

4. Run the server

node server.js

5. Go to localhost:3000 with the right credentials on Metamask

(back to top)

Usage

1. The home page is an overview over all rooms with some basic stats, like invited users and amount of votes.
2. Clicking on the Create VoteRoom button takes you to the creation view.
3. Looking at a specific room, you can see alot of details.
4. Looking at the votes for a room, you can see a list with buttons/actions to take.
5. The manager can also crate a new vote by clicking Add Vote.

(back to top)

Roadmap

• Refactor Frontend to use functional components
• Add loading spinners
• Easier site navigation
• Dark theme

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contact

Project Link: https://github.com/Pyxels/SimpleVote

(back to top)

Acknowledgments

• S2BCAcademys Example which helped with the basic setup
• The professor which offered this course and the ressources

(back to top)