MDF05/VotePeace
Modern full-stack e-voting system using Go (Fiber), GORM, React (Vite), and Material UI
VotePeace - Modern Electronic Voting Platform
VotePeace is an enterprise-grade, secure, and transparent electronic voting platform designed to streamline elections for organizations of all sizes. It ensures integrity, real-time analytics, and a seamless user experience for both voters and administrators.
๐ Project Overview
VotePeace solves the challenge of manual, error-prone voting processes by providing a digital-first solution. It features a robust backend for secure vote processing and a modern, responsive frontend for an engaging voter experience.
Key Capabilities
- Security First: Encrypted vote storage and secure authentication.
- Real-Time Analytics: Instant visualization of election results.
- Cross-Platform: Optimized for web and mobile devices.
- Scalable Architecture: Modular design separating concern between client and server.
๐ Repository Structure Overview
This repository uses a Monorepo structure to house both the server-side and client-side applications.
VotePeace/
โโโ VotePeace-Backend/ # Go (Fiber) + SQLite API Server
โโโ VotePeace-Frontend/ # React (Vite) + MUI Client Application
โโโ ARCHITECTURE.md # System-wide Architecture Documentation
โโโ README.md # You are here
๐ Sub-Projects Description
| Project | Tech Stack | Description | README |
|---|---|---|---|
| Backend | Go, Fiber, GORM, SQLite | The core API server handling auth, business logic, and database persistence. | Read Docs |
| Frontend | React 19, Vite, MUI v7 | The responsive web interface for voters and admins. | Read Docs |
๐ Getting Started
To get the entire system running locally:
Prerequisites
- Go 1.21+
- Node.js 20+
- Git
Quick Start
-
Clone the Repository:
git clone https://github.com/MDF05/VotePeace.git cd VotePeace -
Setup Backend:
cd VotePeace-Backend go mod tidy go run main.goServer runs at
http://localhost:3000 -
Setup Frontend (New Terminal):
cd VotePeace-Frontend npm install npm run devClient runs at
http://localhost:5173
๐ Documentation
Detailed documentation for the entire platform:
| Document | Description |
|---|---|
| System Architecture | High-level system design and communication flow. |
| Governance | Decision-making process and project roles. |
| Contribution Guide | Guidelines for specialized contribution workflows. |
| Code of Conduct | Community standards and enforcement. |
| Security Policy | Vulnerability reporting and security protocols. |
| Changelog | Global release history and version tracking. |
| Roadmap | Future milestones and strategic goals. |
| Support | Resources for getting help. |
| Disclaimer | Legal limitations and usage warnings. |
| License | MIT License details. |
๐ค Contribution Flow
We follow a strict Fork & Pull Request workflow.
- Fork the repo.
- Create a feature branch.
- Commit changes (Conventional Commits).
- Open a Pull Request against
main.
See CONTRIBUTING.md for details.
๐ Security
Security is paramount. Please adhere to the policies outlined in SECURITY.md. Do not report vulnerabilities on public issues.
๐ License
This project is licensed under the MIT License. See LICENSE.
๐ค Maintainers
Muhammad Dava Fahreza
- GitHub: @MDF05