Development Status: 🟢 Complete
This project is a voting booth simulator consisting of four subprojects:
- voting-booth-frontend
- voting-booth-backend
- blockchain-server
- records-backend
voting-booth-frontend is a seamless voting app developed in Angular 7.
voting-booth-backend is an Express server that uses the records-backend to authenticate voters and the blockchain-server to store votes
records-backend is a SpringBoot application that offers a RESTful API for interacting with citizens
blockchain-server is a blockchain that communicates with other blockchains through WebSockets and offers a RESTful API for interacting with the blockchain.
Since this project is managing sensitive information, personally identifiable information (PII). This project secures transmission of data with SSL, meaning it uses the HTTPS protocol. Hence, you need to generate a certificate and key. To do this, make an environment variable for the certificate variable
export VB_CERT_PASSWORD=password
where password can be anything. Then, run
yarn gen-certs
This will generate two certificates and a key based on certificate.cnf, a config file. These certificates will be used by the subprojects for securing their server's communication. The crt and key are used by the node servers, whereas the Spring Boot server uses the p12 certificate, as it only understands this PCKS format. This is not used directly though. A keystore has been generated from the p12 file, through the yarn command, and is then moved to the records server's resources folder. This is moved automatically through the gen-certs command.
You will need to add this certificate--certificate.crt--to your system's trusted certificates, if you wish to not see a warning about the certificate not being trusted, when viewing the frontend in Chrome.
To properly run this web app, you must follow the Getting Started section in each of the four subprojects, and then continue following this section.
After following the Getting Started in the subprojects, the best order to start the projects is records-backend, blockchain-server, voting-booth-backend, voting-booth-frontend, so start each subproject according to the method documented in its README.Once all subprojects are running, the voting-booth-frontend will be able to successfully login and vote. If all services are not running, the frontend will display an error message in a snackbar indicating the reason for failure. This error will implicitly denote the service not running.
+-------------------+ +--------------------+
| | | |
| records-backend | | blockchain-server |
| | | |
+-------------------+ +----------|---------+
| |
+------------+----------+
|
+-----------+----------+ +-----------------------+
| | | |
| voting-booth-backend +----------+ voting-booth-frontend |
| | | |
+----------------------+ +-----------------------+
The voting-booth-backend uses the records-backend and the blockchain-server as services. The records-backend is used to authenticate user information that is provided in the vb-frontend and sent to the vb-backend. The blockchain-server is used to store the votes that are submitted in the vb-frontend and sent to the vb-backend.
- OpenSSL
- Angular 7
- Node 12.13.0
- Express 4
- Nodemailer
- Java 14
- Gradle 6.4.1
- SpringBoot
- Python
- PipEnv
- SQLite
- matttm : Matt Maloney : matttmaloney@gmail.com
If you encounter an issue or a discrepency in the documentation, please message me or open an issue.
This project is licensed under the MIT License - see the LICENSE.md file for details