CoolFace
Apppublic

rajadityaaaaaa/election-navigator

sourceHugging Faceupdated 5mo agoView on Hugging Face
0likes
App README

๐Ÿ—ณ๏ธ Election Navigator (India)

A GPS for Democracy โ€” Your Step-by-Step Guide to Voting in India

Tech Stack

LayerTechnology
FrontendVanilla HTML5, CSS3, JavaScript (ES2022)
BackendNode.js 18+ ยท Express 4
Data StoreJSON flat files (MVP)
LintingESLint 9 (flat config)
FormattingPrettier 3
TestingJest ยท Supertest
CI/CDGitHub Actions

Project Structure

Election assistant/
โ”œโ”€โ”€ .github/
โ”‚   โ””โ”€โ”€ workflows/
โ”‚       โ””โ”€โ”€ ci.yml              โ† GitHub Actions CI pipeline
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ backend/
โ”‚   โ”‚   โ”œโ”€โ”€ server.js           โ† Express app entry point
โ”‚   โ”‚   โ”œโ”€โ”€ routes/             โ† API route definitions
โ”‚   โ”‚   โ”œโ”€โ”€ controllers/        โ† Business logic
โ”‚   โ”‚   โ””โ”€โ”€ services/           โ† Data & Logic services
โ”‚   โ”œโ”€โ”€ frontend/
โ”‚   โ”‚   โ”œโ”€โ”€ index.html          โ† App shell
โ”‚   โ”‚   โ”œโ”€โ”€ css/
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.css       โ† Base styles + design tokens
โ”‚   โ”‚   โ””โ”€โ”€ js/
โ”‚   โ”‚       โ””โ”€โ”€ app.js          โ† Frontend entry point
โ”‚   โ””โ”€โ”€ data/
โ”‚       โ”œโ”€โ”€ elections.json      โ† Indian State election data seed
โ”‚       โ””โ”€โ”€ glossary.json       โ† Jargon Buster term seed (Indian context)
โ”œโ”€โ”€ tests/
โ”‚   โ””โ”€โ”€ api.test.js             โ† Integration tests
โ”œโ”€โ”€ .env.example
โ”œโ”€โ”€ package.json
โ”œโ”€โ”€ TASKS.md
โ””โ”€โ”€ README.md

Getting Started

1. Prerequisites

  • โ€”Node.js โ‰ฅ 18.0.0
  • โ€”npm โ‰ฅ 9.0.0

2. Install

bash
npm install

3. Run in Development

bash
npm run dev

Open http://localhost:3000

4. API Endpoints

MethodEndpointDescription
GET/api/healthServer health check
GET/api/timeline?state=MHVoting deadlines for Maharashtra
GET/api/jargonIndian election glossary
POST/api/eligibilityCheck Indian voter eligibility

Design Principles

  • โ€”Reduce Cognitive Load โ€” One step at a time
  • โ€”Radical Neutrality โ€” Process only, no party endorsements
  • โ€”Accessibility First โ€” WCAG 2.1 AA, mobile-first
  • โ€”Verified Data โ€” ECI (voters.eci.gov.in), NVSP, and ADR India (MyNeta) sources only

Election Navigator (India) ยท April 2026