https://github.com/nventive/conuhacks-2022
https://github.com/nventive/conuhacks-2022
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nventive/conuhacks-2022
- Owner: nventive
- Created: 2022-01-25T17:39:40.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-30T07:37:17.000Z (over 4 years ago)
- Last Synced: 2025-04-13T00:14:39.966Z (about 1 year ago)
- Language: JavaScript
- Size: 1.11 MB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ConuHacks 2022 Challenge. Decentralized Election Platform
## Objective
Build a decentralized election platform everyone in the galaxy would use to vote.
> This is a decentralized voting system based on Blockchain technology, which is distributed over a network using smart contracts.
## Guidelines
- This github repo contains a full README to help you get started (see below) and a fully functional smart contract with voting capabilities, it's a good starting point! Use it or start from scratch, your choice!
- Try to follow the theme
- Have fun with it! Try things.
- Provide a submission video (showcase) showing what you built, you should also present your ideas for future improvements.
- Come hang out in the Gathertown (nventive, in career fair section), we have debug rooms where developers can help you get started!
## Ideas of things to add/improve
> don't limit yourself to this list
- Improve the way to identify yourself, possibly via metamask.
- Improve overall security of the React app and smart contract
- Improve the UX/UI, make it easy to vote for everyone
- Integrate your smart contract in the Ropsten test network
# README
## Getting Started - Setup
### _Additionnal step on Windows_:
If you get the following error while running any script:
You'll need to run `Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass`.
### Building the smart contract
1. First, you'll need truffle to interact with the smart contract :
```
npm i -g truffle
```
2. Truffle gives you a development environment with 10 accounts with Ethereum so you can interact with the contract, under the `/contracts` directory, run:
```
truffle develop
```
3. Also, to compile the smart contract, under the `/contracts` directory, run:
```
truffle migration
```
4. Update the `backend.py` file with the contract address that `truffle migrate` generates you. Also, update the private key list to the private keys given by `truffle develop` environment.
Here's some screenshots to help you with this step:
| truffle migration | Verify private keys |
| :-------------------------------------: | :---------------------------------------: |
|  |  |
### Backend
For the backend, you'll need Python and pip. If you don't have it, follow the instructions on https://www.python.org/downloads/.
1. Let's create a virtual env for our project's dependencies on the root of the project:
```
pip install virtualenv
virtualenv venv
source venv/bin/activate -> .\Scripts\activate on Windows
pip install -r requirements.txt
```
2. You can now run the backend by running:
```
python backend.py
```
### Frontend
The frontend is a React app. To run it, first go to the `/frontend` directory and run:
```
yarn install
yarn start
```
You should see the login screen :
You can also access the voting results by accessing the http://localhost:3000/admin link. Username is `test` and password is `test123`:
## Possible improvements
- Add Metamask integration in the login page, currently to login, you simply enter a number from 0 to 9 that links to the proper account from the truffle environment.
- Improve overall security of the React app/smart contract
- Clean the frontend code, many components could be reused.
- Add methods to the smart contract other than vote (vote delegation for example).
- Integrate this smart contract in the Ropsten test network. You'll also need to use the Ropsten Ethereum Faucet to add test Ethereum to your accounts.