🎓 Shiksha Flow - AI-Powered Student Support Platform

Shiksha Flow is a comprehensive educational platform that combines AI-powered complaint management and mental health assessment to provide holistic student support. Built with Next.js 16, Firebase, and Google Gemini AI.

🌟 Key Features

🤖 AI-Powered Complaint Management

Smart Assignment: AI automatically assigns complaints to the most suitable authority based on:
- Student type (Hosteller, Day Scholar, Night Scholar, Remote Learner)
- Complaint content and context
- Authority workload and availability
- Department matching
Automatic Classification: AI infers complaint type (Administrative, Infrastructure, Hostel, Academic, Other)
Priority Determination: AI sets urgency levels (Low, Medium, High, Urgent) with 0-10 scoring
Sentiment Analysis: Detects student emotional state (positive, neutral, negative, frustrated, angry)
Key Issues Extraction: Identifies 2-5 main issues from complaint description
Smart Scheduling: Prioritizes complaints based on urgency (Urgent: 0-15 mins, High: 15-30 mins, etc.)

🧠 Mental Health Assessment System

AI-Powered Personalized Questions: Generates 15 contextual questions based on student profile
Comprehensive Analysis: Dual-report system with:
- Mental State Report: Current state, stress level, key findings, concerns
- Improvement Report: Immediate actions, short-term strategies, long-term goals
Professional Referral: Recommends professional help when needed
Actionable Insights: Tailored recommendations with priority-based actions
Print-Friendly Reports: Beautifully formatted 2-page reports
Progress Tracking: Tracks assessment history and improvement

🔐 Secure Authentication & Authorization

Firebase Authentication with Email/Password
Role-based access control (Student, Faculty, Staff, Admin)
Protected routes and API endpoints
Firestore security rules enforcement

📊 Analytics & Reporting

Dashboard with real-time statistics
Complaint tracking by status, priority, student type
Mental health trends and insights
Admin analytics for institutional oversight

🚀 Quick Start

Prerequisites

Node.js 18+ and npm/yarn
Firebase account
Google Gemini API key

Installation

Clone the repository

git clone https://github.com/your-org/shiksha-flow.git
cd shiksha-flow

Install dependencies

npm install
# or
yarn install

Set up environment variables

Create .env.local file in the root directory:

# Firebase Configuration (Public)
NEXT_PUBLIC_FIREBASE_API_KEY=your_api_key
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_project.firebaseapp.com
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_project.appspot.com
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id

# Firebase Admin (Private - Server Only)
FIREBASE_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n"
FIREBASE_CLIENT_EMAIL=firebase-adminsdk@your_project.iam.gserviceaccount.com

# Google Gemini AI (Private - Server Only)
GEMINI_API_KEY=your_gemini_api_key

Set up Firebase

# Login to Firebase
firebase login

# Initialize Firebase (if not already done)
firebase init

# Deploy Firestore rules
firebase deploy --only firestore:rules

Run development server

npm run dev
# or
yarn dev

Open http://localhost:3000 to see the application.

📁 Project Structure

shiksha-flow/
├── src/
│   ├── app/                          # Next.js App Router
│   │   ├── api/                      # API Routes
│   │   │   ├── ai/
│   │   │   │   └── assign-complaint/ # AI complaint assignment
│   │   │   ├── mental-health/        # Mental health APIs
│   │   │   │   ├── generate-personalized-questions/
│   │   │   │   └── analyze-comprehensive/
│   │   │   └── register-student/
│   │   ├── dashboard/                # Dashboard pages
│   │   │   ├── complaints/           # Complaint management
│   │   │   ├── mental-health/        # Mental health assessment
│   │   │   └── register-student/
│   │   └── login/                    # Authentication
│   ├── components/                   # React components
│   │   ├── auth/                     # Auth guards
│   │   ├── complaints/               # Complaint components
│   │   ├── mental-health/            # Mental health components
│   │   ├── layout/                   # Layout components
│   │   └── ui/                       # Reusable UI components
│   ├── lib/                          # Utilities
│   │   ├── firebase/                 # Firebase config & helpers
│   │   └── firestore/                # Firestore queries
│   ├── types/                        # TypeScript types
│   ├── hooks/                        # Custom React hooks
│   ├── context/                      # React Context (Auth)
│   └── config/                       # App configuration
├── docs/                             # Documentation
│   ├── API.md                        # API documentation
│   ├── Structure.md                  # Project structure
│   └── IMPACT_AND_FEASIBILITY.md     # Impact analysis
├── public/                           # Static assets
├── firestore.rules                   # Firestore security rules
├── firebase.json                     # Firebase configuration
└── package.json                      # Dependencies

See docs/Structure.md for detailed structure.

🛠️ Tech Stack

Layer	Technology	Purpose
Frontend	Next.js 16.1.1 (React 19)	Server-side rendering, App Router
Styling	Tailwind CSS 4	Utility-first CSS framework
Animations	Framer Motion	Smooth UI animations
Backend	Next.js API Routes	Serverless API endpoints
Database	Firebase Firestore	NoSQL cloud database
Authentication	Firebase Auth	User authentication & management
AI	Google Gemini 1.5 Flash	Natural language processing
Deployment	Vercel	Production hosting
Language	TypeScript	Type-safe development

📚 Documentation

API Documentation - Complete API reference
Project Structure - Detailed file structure
Impact Analysis - Feasibility & ROI study

🔑 Key Components

Complaint System Flow

Student Submits → AI Analyzes → Auto-Assigns → Authority Reviews → Resolution (Also real time status update on student's dashboard)

Mental Health Flow

Welcome → dashboard/mental-health → 15 Questions → AI Analysis → Dual Reports → Actions

🚀 Deployment

Build for Production

npm run build
npm run start

Deploy to Vercel

vercel deploy --prod

Deploy Firebase Rules

firebase deploy --only firestore:rules

🧪 Testing

Run Development Server

npm run dev

Build Test

npm run build

Lint Check

npm run lint

📊 Performance

Page Load Time: ~1.5s
Question Generation: ~3-4s
AI Analysis: ~5-8s
Database Queries: ~150ms
Concurrent Users: 100+ supported

🔒 Security Features

✅ Firebase Authentication
✅ Firestore Security Rules
✅ Role-Based Access Control (RBAC)
✅ Environment Variable Protection
✅ API Route Authentication
✅ Input Validation & Sanitization
✅ HTTPS Only
✅ CORS Protection

🤝 Contributing

Contributions are welcome! Please:

Star and Fork the repository
Create a feature branch (git checkout -b feature/AmazingFeature)
Commit changes (git commit -m 'Add AmazingFeature')
Push to branch (git push origin feature/AmazingFeature)
Open a Pull Request

📄 License

This project is licensed under the MIT License.

👥 Team

📞 Support

For issues, questions, or suggestions:

Create an Issue
Documentation: docs/

🎯 Roadmap

Phase 1 (✅ Complete)

Core complaint system
AI-powered assignment
Mental health assessment
Dual-report generation

Phase 2 (In Progress)

Analytics dashboard
Email notifications
Report history tracking
User feedback collection

Phase 3 (Planned)

Multi-language support
Advanced analytics
Integration with LMS
Mobile apps (iOS/Android)

🌟 Acknowledgments

Next.js - React framework
Firebase - Backend services
Google Gemini - AI capabilities
Tailwind CSS - Styling
Vercel - Hosting platform

Built with passion for students' wellness and academic success

Last Updated: January 9, 2026

Name		Name	Last commit message	Last commit date
Latest commit History 28 Commits
docs		docs
public		public
src		src
.env.example		.env.example
.firebaserc		.firebaserc
.gitignore		.gitignore
README.md		README.md
eslint.config.mjs		eslint.config.mjs
firebase.json		firebase.json
firestore.indexes.json		firestore.indexes.json
firestore.rules		firestore.rules
next.config.ts		next.config.ts
package-lock.json		package-lock.json
package.json		package.json
postcss.config.mjs		postcss.config.mjs
tsconfig.json		tsconfig.json

Folders and files

Latest commit

History

Repository files navigation