Skip to content

README.md

Latest commit

 

History

History
199 lines (150 loc) · 4.53 KB

README.md

File metadata and controls

199 lines (150 loc) · 4.53 KB
Raw

🌍 VishwaGuru

optimize-lazy-loading-313 VishwaGuru is an AI-powered platform designed to help users analyze issues and generate actionable solutions using modern web technologies and AI models.

=

✨ Features

  • 🤖 AI-generated action plans using Google Gemini
  • ⚡ FastAPI-powered backend
  • 🎨 Modern React + Vite frontend
  • 📱 Telegram bot integration
  • 🗄️ SQLite (dev) & PostgreSQL (prod) support
  • ☁️ Flexible deployment options

🛠️ Project Setup (Local)

📥 Clone the Repository

git clone https://github.com/Ewocs/VishwaGuru.git
cd VishwaGuru

⚙️ Backend Setup

Create Virtual Environment

# Linux/macOS
python3 -m venv venv
source venv/bin/activate

# Windows
python -m venv venv
venv\Scripts\activate

Install Dependencies

pip install -r backend/requirements.txt

🔐 Environment Configuration

cp .env.example .env
TELEGRAM_BOT_TOKEN=your_bot_token
GEMINI_API_KEY=your_api_key
DATABASE_URL=sqlite:///./data/issues.db

🎨 Frontend Setup

cd frontend
npm install

🏃‍♂️ Running Locally

Service Command URL
Backend PYTHONPATH=backend python -m uvicorn main:app --reload http://localhost:8000
Frontend cd frontend && npm run dev http://localhost:5173

Windows Note

set PYTHONPATH=backend & python -m uvicorn main:app --reload

☁️ Deployment Options

  • Firebase
  • Netlify + Render
  • Railway

🛠️ Tech Stack

  • React, Vite, Tailwind CSS
  • Python, FastAPI
  • SQLite, PostgreSQL
  • Google Gemini API

📚 Documentation

  • ARCHITECTURE.md
  • DEPLOYMENT_GUIDE.md
  • frontend/README.md
  • backend/README.md

📄 License

GNU Affero General Public License v3.0 (AGPL-3.0)

VishwaGuru Banner License Python Visitors React FastAPI Firebase

Empowering India's youth to engage with democracy through AI-powered civic action 🚀

📖 Documentation • 🚀 Quick Start • 🤝 Contributing • 📋 Issues

✨ What is VishwaGuru?

VishwaGuru is an open source platform that transforms civic engagement in India. Using cutting-edge AI, it simplifies contacting representatives, filing grievances, and organizing community actions.

🎯 Mission: Make democracy accessible to every Indian citizen through technology

Contributors

🌟 Key Features


AI Action Plans
Generates personalized WhatsApp messages and email drafts using Google's Gemini API
Multi-Platform
Report issues via modern web interface or Telegram bot
Production Ready
SQLite for development, PostgreSQL for production

Modern Stack
React + Vite frontend, FastAPI backend
India-Centric
Built for Indian languages and governance systems
Open Source
Free, transparent, and community-driven

🏗️ Architecture & Data Flow

The content continues as it was...