Skip to content

README.md

Latest commit

 

History

History
70 lines (51 loc) · 2.75 KB

README.md

File metadata and controls

70 lines (51 loc) · 2.75 KB
Raw

🗳️ ElectraGuide: Empowering the Indian Voter

ElectraGuide is a premium, AI-powered election assistant designed to help Indian citizens navigate the electoral process with confidence and clarity. Built with a modern, high-performance tech stack, it provides a seamless experience for first-time voters and seasoned citizens alike.

ElectraGuide Banner (Note: Placeholder for actual OG image)

🚀 Key Features

  • 🤖 AI Election Assistant: Multi-lingual chat assistant (English & Hindi) to answer all your election-related queries.
  • 🗺️ Constituency Tracker: Get real-time details and candidate information for your local constituency.
  • 🎮 Voting Simulator: Practice the voting process in a risk-free, 3D interactive environment.
  • 📅 How to Vote Guide: A comprehensive, step-by-step roadmap from registration to the polling booth.
  • 🛡️ Myth Buster: Fact-checked information to combat common election misinformation and rumors.
  • 🏆 Gamified Progress: Earn points and badges as you learn more about your democratic rights.

🛠️ Technology Stack

  • Framework: Next.js 15+ (App Router)
  • Language: TypeScript
  • Styling: Tailwind CSS v4 (Standard CSS + @theme)
  • AI Engine: Google Gemini Pro via AI SDK
  • Icons: Lucide React
  • Animations: Framer Motion & Custom CSS Utilities
  • Typography: Outfit

🎨 Design Philosophy

ElectraGuide utilizes a Professional Civic-Tech aesthetic:

  • Tricolor Accent: Subtle nods to the Indian flag (Saffron, White, Green) throughout the UI.
  • Glassmorphism: Modern backdrop blurs and semi-transparent panels for a premium feel.
  • Dark-to-Light Theme: A primary palette focused on deep Navy (#0F172A) for authority and Slate for readability.
  • Accessibility: High-contrast ratios and a clear typography scale using the "Outfit" font family.

🏁 Getting Started

Prerequisites

  • Node.js 20+
  • npm or yarn

Installation

  1. Clone the repository:

    git clone https://github.com/Aliyan-cmd/ElecteraGuide.git

  2. Install dependencies:

    npm install

  3. Set up environment variables: Create a .env.local file and add your Google Gemini API Key:

    GOOGLE_GENERATIVE_AI_API_KEY=your_api_key_here

  4. Run the development server:

    npm run dev

  5. Open http://localhost:3000 with your browser to see the result.

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

🇮🇳 Made with ❤️ for India

ElectraGuide is built to strengthen democracy by making election information accessible, engaging, and accurate.