-lightgrey?style=for-the-badge){kind=icon}
A decentralized voting platform prototype.
- ☀ Introduction
- 🎯 Motivation
- 📷 Preview
- 💿 Setup
- 🛠 Technologies Used
- 🧪 Tests
- 🚦 Project Status
- ✉ Contact
For my last university semester, I had to dedicate 18h/week to a project, just like my previous semester where I worked on RunApp.
This semester, I wanted to explore the world of crypto, but more on that later.
As I started planning out this idea, I quickly met Antoine Gagnon, a very smart peer that I somehow never crossed paths with during my whole university studies.
I could not have asked for a better partner.
This repository is the product of our labour.
In the end, we built the POC of a decentralized voting platform that runs on the Ethereum blockchain. This includes:
- The development, testing and deployment of a ballot smart
- The design and implementation of web3 DAPP that interacts with a smart contract (the web application used for voting and seeing the results)
My goals for this project were to...
Blockchain and Web3 are rapidly growing in popularity thanks to cryptocurrencies, NFTs and other financial applications. Nonetheless, the properties of blockchain do have the potential to serve other purposes like verifiable voting, supply chain monitoring, identity verification, etc.
I'm a big fan of NextJS, but as responsible developers, it is always a good idea to stay aware of what other frameworks have to offer.
I used MUI in some old projects that never saw the light of day, but I was not a fan of the default Material Design styles. Therefore, when I discovered TailwindCSS, I quickly moved over. Recently, MUI received a major update that highly improved the theme customization ability. I was desperate to try out!
preview.mp4
- Node v16 or above
- NPM
- Docker and docker-compose
- A web browser (Chrome for example) with MetaMask installed
First, clone the repository with the following command:
git clone [email protected]:vcheeney/voting-platform.gitThen, setup the environment variables (tip: copy/paste our .env.example file, the default values work just fine):
cp .env.example .envFinally, run everything with docker-compose:
docker-compose -f dc.local-blockchain.yml -f dc.database.yml -f dc.database.prod.yml -f dc.web.yml upFor development purposes, follow the more thorough manual setup steps.
In order to deploy the smart contract to a different network, follow the instructions here.
Once everything is loaded properly, the web app will be accessible at http://localhost:3000/.
In your web browser:
- Open the MetaMask extension by clicking on its icon in the browser toolbar
- Click on "Add Network"
- Fill the requested fields with the following information:
- Network Name: Hardhat
- New RPC URL: http://127.0.0.1:8545/
- Chain ID: 31337
- Currency Symbol: leave empty
- Block Explorer URL: leave empty
- Click on "Save"
In the MetaMask extension:
- Select the Hardhat network that you just configured
- Import the first account from the list that appeared when you previously ran
npx hardhat nodein your other terminal (which should still be open) - Optional: Rename the account to Chairperson or any other familiar name.
As you may notice in the docker-compose output window, the web app generates seed users for you to register as. When asked to register your account, you can use a secret code and date of birth combination in the web/prisma/seed-users.json file.
- Remix 1.1.1 - Full stack web framework
- Ethers 5.5.3 - JavaScript library to interact with smart contracts
- MUI 5.3.0 - React components library
- Prisma 3.8.1 - TypeScript ORM
- Hardhat 2.8.3 - Ethereum development environment
- Solidity 0.8.12 - EVM compatible smart contract development language
- Typechain 5.2.0 - Package to generate TS types for smart contracts
- Mocha 9.1.0 - JavaScript test framework
- Chai 4.3.6 - TDD assertion library
- Waffle 3.4.0 - Chai matchers for smart contracts
When developing smart contracts, it is very important to do proper testing so that no funds are lost in production. To run the tests, do the following:
# Move into the hardhat subdirectory
cd hardhat
# Run the tests
npx hardhat testI archived this project in April 2022 as it served its purpose. 👍
I learned a lot about web3 and other web related topics during this school semester.
- how to write & test a Solidity smart contract
- how to listen to events emitted from a smart contract
- how to create transactions from a backend server using a custom signer (i.e.: there is no MetaMask there)
- how to deploy a smart contract on a public testnet
- what to do when encountering the "Nonce too high" error when working with a local hardhat network
- how to use nested routes in the Remix application framework
- the benefits of using Prisma to create and maintain our data schema:
- Simple management of migrations
- Autogenerated TypeScript client to interact with our data
- Simple tool to explore/modify data in our database (Prisma Studio)
- how to use the theming feature of MUI to create a unique design system
- how to properly use environment variables when working with a Docker Compose setup
- how to set up VS Code so that we have consistent EOL
- about the SCRE.IO chrome extension to record my screen very easily (this makes good PR previews)
I'm excited to move on from this project to explore new horizons in the blockchain/crypto space.