Skip to content

Commit ff45d00

Browse files
docs: update README
1 parent 3e31272 commit ff45d00

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
1-
# ballotcure
1+
# BallotCure
22

3-
This template should help get you started developing with Vue 3 in Vite.
3+
A web application for visualizing and searching Philadelphia ballot deficiency data from the 2024 General Election. The application provides an interactive map interface to explore ballot issues by division and search for individual voter records.
4+
5+
## About This Project
6+
7+
BallotCure helps voters and election officials identify and track mail-in ballot deficiencies in Philadelphia. Users can:
8+
9+
- Search for voters by name to see their ballot status
10+
- Click on map divisions to view all ballot deficiencies in that area
11+
- View statistics showing the number of deficient ballots per division
12+
- Automatically detect and display the user's voting division based on their location
13+
14+
## Architecture Note
15+
16+
This project was originally developed with a Supabase backend for real-time data management. As the election data became finalized and no longer required updates, the project was archived with a static data snapshot (November 2024). The application now runs entirely client-side using static JSON files, eliminating the need for a backend database.
17+
18+
## Technology Stack
19+
20+
- **Frontend Framework**: Vue 3 with Composition API
21+
- **Build Tool**: Vite
22+
- **Mapping**: MapLibre GL JS
23+
- **Data**: Static JSON files (3,341 ballot records, 1,374 divisions)
424

525
## Recommended IDE Setup
626

0 commit comments

Comments
 (0)