OmniFlow - Next-Generation College ERP Platform

A modern, comprehensive Enterprise Resource Planning system built for higher education institutions. OmniFlow streamlines student information, academics, placements, finance, campus operations, and more in a single, unified platform with AI-powered features.

🌟 Overview

OmniFlow is a web-based ERP designed to replace fragmented legacy systems with an intuitive interface serving students, faculty, administrators, placement officers, and recruiters. The platform provides role-based dashboards, comprehensive academic management, advanced placement features, campus operations, AI chatbots, and real-time communication. Every feature is carefully crafted with proper authentication, real-time data synchronization, and an exceptional user experience.

✨ Core Features

📚 Academic Management

Courses & Syllabus

Course Catalog - Browse and manage courses with detailed descriptions, prerequisites, and learning outcomes
Course Materials - Centralized repository for notes, assignments, past papers, study materials, and resources
Syllabus Management - Upload and view course syllabi with topic breakdowns
Course Analytics - Track completion rates, student engagement, and performance metrics
Multi-Department Support - Organize courses by departments with faculty assignments

Timetable Management

Personalized Schedules - View customized timetables based on enrolled courses
Conflict Detection - Automatic detection of scheduling conflicts
Faculty Scheduling - Create and publish timetables with room assignments
Calendar Integration - Export to Google Calendar, Outlook, and iCal formats
Multi-View Support - Day, week, and month views with color-coded classes

Attendance Tracking

QR Code Scanning - Quick attendance marking via QR codes
Manual Attendance - Traditional roll-call interface for faculty
Real-Time Updates - Instant sync across student and faculty dashboards
Attendance Analytics - View attendance percentages, trends, and alerts
Absence Tracking - Monitor student absences with notifications
Export Reports - Generate attendance reports in PDF and Excel formats

Examinations

Exam Scheduling - Create exam schedules with date, time, and venue details
Seating Arrangements - Automated seating allocation with conflict prevention
Grade Management - Enter, publish, and manage grades with grade distribution analytics
Transcript Generation - Auto-generate official transcripts with institutional branding
Result Analytics - Class performance analysis with statistical insights
Revaluation Requests - Track and manage grade revaluation workflows

Assignments

Assignment Creation - Create assignments with rich text, file attachments, and due dates
Submission Tracking - Monitor submission status, late submissions, and pending work
Grading System - Grade submissions with rubrics, comments, and feedback
Auto-Reminders - Automatic notifications for upcoming and overdue assignments
Plagiarism Detection - Integration-ready for plagiarism checking tools
Peer Review - Enable peer-to-peer assignment reviews

💼 Placement & Career Development

Job Board & Recruitment

Job Postings - Browse jobs with filters for role, company, location, salary, and skills
Quick Apply - One-click job applications with saved resumes
Application Tracking - Track all applications with status updates (Applied, Shortlisted, Interviewed, Offered, Rejected)
Company Profiles - Detailed company information, culture, and past placement records
Interview Scheduling - Automated interview slot booking and calendar sync
Offer Management - Accept, decline, or negotiate offers with letter downloads

Recruitment Drives

Drive Management - View and register for campus placement drives
Eligibility Filtering - Auto-filter drives based on student eligibility (CGPA, department, year)
Multi-Round Tracking - Track progress through aptitude, technical, HR rounds
Live Updates - Real-time notifications for drive updates and selections
Results Dashboard - View placement statistics and selection lists

Resume Builder & Analyzer

Interactive Resume Builder - Drag-and-drop resume creator with 8+ professional templates
Real-Time Preview - Live preview while editing with instant updates
Multi-Format Export - Download as PDF, DOCX, or plain text
AI Resume Analyzer - Get AI-powered feedback on content, formatting, and ATS compatibility
Keyword Optimization - Suggestions for industry-specific keywords
Version History - Save and manage multiple resume versions
ATS Score - Check resume compatibility with Applicant Tracking Systems

Placement Profile Management

Comprehensive Profiles - Manage skills, projects, certifications, achievements, and experiences
Profile Visibility - Control recruiter visibility and profile sharing
Profile Analytics - Track profile views and recruiter engagement
Document Vault - Store resumes, certificates, and portfolio items
Skill Endorsements - Peer and faculty skill endorsements
Project Showcase - Display academic and personal projects with media

Career Portal

Career Resources - Access career guides, interview tips, and skill development materials
Industry Insights - View salary trends, job market analysis, and career paths
Alumni Network - Connect with alumni for mentorship and career advice
Mock Interviews - Schedule and practice mock interviews with faculty
Skill Gap Analysis - Identify missing skills for target job roles
Career Roadmaps - Personalized career progression recommendations

💰 Finance Management

Fee Management

Fee Structure - View detailed fee breakdown by semester, category, and charges
Payment History - Access complete payment records with transaction IDs
Outstanding Balance - Real-time balance tracking with due date alerts
Fee Receipts - Download official receipts with institutional branding
Payment Plans - Installment plans with automated reminders
Scholarship Tracking - Monitor applied scholarships and fee waivers

Online Payments

Multiple Payment Gateways - Support for UPI, cards, net banking, and wallets
Supported Methods:
- UPI (Google Pay, PhonePe, Paytm, WhatsApp Pay)
- Debit/Credit Cards (Visa, Mastercard, Rupay, Amex)
- Net Banking (50+ banks)
- Mobile Wallets (Paytm, Amazon Pay, MobiKwik)
- Bank Transfer with auto-verification
Instant Confirmation - Real-time payment status with email and SMS notifications
Transaction Security - PCI-DSS compliant payment processing
Payment Analytics - Track payment trends and collection efficiency
Auto-Reconciliation - Automatic matching of payments with fee records

Financial Reporting

Collection Reports - Track fee collection by department, semester, and category
Outstanding Reports - Monitor pending fees with aging analysis
Revenue Analytics - Visualize revenue streams and trends
Refund Management - Process and track fee refunds
Audit Trail - Complete transaction history with user logs
Export Options - Generate reports in PDF, Excel, and CSV formats

🛏️ Campus Services

Hostel Management

Issue Reporting - Report maintenance, amenities, and safety issues with photo attachments
Priority Categorization - Low, medium, high, and urgent priority levels
Status Tracking - Track issue resolution from reported to resolved
Issue Timeline - View complete issue history with timestamps
Room Allocation - Manage room assignments and transfers
Hostel Analytics - Dashboard for issue trends and resolution times

Night Canteen Service

Food Menu - Browse complete menu with images, descriptions, and prices
Online Ordering - Place orders with delivery time and location preferences
Order Tracking - Real-time order status (Received, Preparing, Ready, Delivered)
Payment Integration - Pay online or cash on delivery
Order History - View past orders with reorder functionality
Menu Management - Admin interface for menu updates and pricing

Campus Map (Interactive)

3D Campus Navigation - Interactive 3D map of campus buildings and facilities
Building Information - Detailed building info with departments and facilities
Route Planning - Get directions between campus locations
Facility Locator - Find classrooms, labs, libraries, cafeterias, and amenities
Road and Path Drawing - Custom road layouts with multi-segment support
Accessibility Features - Mark wheelchair-accessible routes and elevators

Library Management

Book Catalog - Search books by title, author, ISBN, or category
Book Lending - Issue and return books with due date tracking
Reservation System - Reserve books currently on loan
Digital Resources - Access e-books, journals, and research papers
Fine Tracking - Auto-calculate overdue fines with payment integration
Reading History - View borrowing history and recommendations

Room Booking System

Facility Booking - Book seminar halls, conference rooms, and labs
Availability Calendar - View real-time room availability
Conflict Prevention - Automatic detection of booking conflicts
Approval Workflow - Request and approve bookings with notifications
Recurring Bookings - Schedule weekly or monthly recurring events
Resource Management - Track projectors, equipment, and furniture

💬 Communication & Collaboration

WhatsApp-Grade Chat System

Department Chat Groups - Auto-created groups for departments and semesters
Direct Messaging - One-on-one conversations with students and faculty
Group Information - View group members, descriptions, and admins
Message Search - Full-text search across all conversations
Media Sharing - Share images, documents, and files
Read Receipts - See when messages are delivered and read
Typing Indicators - Real-time typing status
Message Reactions - React to messages with emojis
Pin Important Messages - Pin announcements and important info
Group Admin Controls - Manage members, settings, and permissions

Notifications System

Real-Time Alerts - Instant notifications for assignments, exams, and announcements
Push Notifications - Browser push notifications for important updates
Email Digests - Daily or weekly email summaries
Notification Center - View all notifications in one place
Custom Preferences - Control notification types and delivery methods
Priority Notifications - Critical alerts with special highlighting
Read/Unread Tracking - Mark notifications as read or archive them

Announcements

College-Wide Announcements - Broadcast messages to all users
Department Announcements - Target messages to specific departments
Role-Based Announcements - Send to students, faculty, or specific roles
Scheduled Publishing - Schedule announcements for future dates
Attachment Support - Include documents, images, and links
Analytics - Track announcement reach and engagement

🎓 Student Services

Student Profile Management

Personal Information - Edit contact details, emergency contacts, and addresses
Academic History - View courses, grades, and academic progress
Document Uploads - Upload ID proofs, certificates, and documents
Transcript Downloads - Generate and download official transcripts
Privacy Settings - Control profile visibility and data sharing
Profile Completeness - Track profile completion with suggestions

Clubs & Activities

Club Directory - Browse and join student clubs and organizations
Event Calendar - View upcoming club events and activities
Membership Management - Track club memberships and roles
Event Registration - Register for events with RSVP tracking
Activity Feed - View club updates, photos, and announcements
Leadership Dashboard - Manage club members and events (for leaders)

Leave Management

Leave Applications - Apply for medical, casual, or academic leave
Approval Workflow - Track leave approval through faculty and admin
Leave Balance - View remaining leave days by category
Leave History - Access past leave records and approvals
Leave Calendar - Visualize leave schedules and team availability
Auto-Notifications - Alerts to approvers and applicants

⚙️ Administration & Management

User Management

Complete User Lifecycle - Create, edit, disable, and delete user accounts
Role Assignment - Assign roles: Super Admin, College Admin, Faculty, Student, Placement Officer, Recruiter
Bulk User Import - Import users from CSV/Excel files with validation
Password Management - Reset passwords and enforce password policies
User Search - Advanced search by name, email, role, or department
User Analytics - Track user activity, login frequency, and engagement
Account Status - Enable, disable, or suspend accounts

Department Management

Create Departments - Add departments with names, codes, and descriptions
Department Heads - Assign and manage department heads
Enrollment Tracking - Monitor student and faculty counts
Department Statistics - View course offerings, placements, and performance
Budget Allocation - Track department budgets and expenses
Inter-Department Coordination - Share resources and collaborate

Faculty Management

Faculty Profiles - Comprehensive profiles with qualifications, specializations, and experience
Course Assignments - Assign courses to faculty with workload tracking
Teaching Schedule - View complete teaching timetables
Performance Metrics - Track student feedback, course completion, and engagement
Research & Publications - Record research papers, publications, and conferences
Leave Management - Faculty leave applications and approvals

College Settings (Branding)

College Logo Upload - Upload institutional logo with preview
Branding Configuration - Set college name, tagline, and colors
Contact Information - Configure email, phone, website, and address
Academic Calendar - Set semester dates, holidays, and exam schedules
System Policies - Configure late fee policies, attendance requirements, and rules
Theme Customization - Set default theme and accent colors

System Configuration

General Settings - Configure system-wide parameters
Integration Settings - Set up third-party integrations (Google, Microsoft, etc.)
Email Configuration - SMTP settings for email notifications
Storage Settings - Configure file storage limits and allowed formats
Security Settings - Password policies, session timeouts, and 2FA
Backup & Recovery - Automated backup schedules and restore options

System Monitoring

System Health Dashboard - Monitor server status, database health, and API uptime
Performance Metrics - Track page load times, API response times, and errors
User Activity Logs - Complete audit trail of user actions
Error Tracking - Real-time error monitoring and alerts
Analytics Dashboard - User engagement, feature usage, and trends
Capacity Planning - Monitor storage, bandwidth, and resource usage

🤖 AI-Powered Features

AI Chatbots (Dual System)

Landing Chatbot - Pre-login assistance for prospective students and visitors
- Answer questions about admissions, courses, and facilities
- Provide campus tour information
- Share contact details and application procedures
- Powered by Google Gemini 2.5 Flash
Saathi (Student Assistant) - Post-login personalized assistant
- Answer academic queries and course information
- Provide placement guidance and career advice
- Help with navigation and feature discovery
- Contextual assistance based on user role
- Multi-language support
- Voice input and output capabilities

AI Resume Analyzer

Content Analysis - Evaluate resume content quality and completeness
ATS Compatibility Check - Score resume for Applicant Tracking Systems
Keyword Recommendations - Suggest industry-relevant keywords
Format Optimization - Identify formatting issues and improvements
Section Completeness - Check for missing critical sections
Personalized Feedback - Actionable suggestions for improvement
Benchmark Scoring - Compare against successful resumes in the field

📖 Help & Support

Comprehensive Documentation System

40+ Help Articles covering:
- Getting Started - Platform overview, first login, and setup
- Account & Profile - Profile management, password reset, and settings
- Academics - Courses, attendance, assignments, exams, and grades
- Finance - Fee payment, receipts, and financial aid
- Placements - Job applications, resume building, and career resources
- Settings & Privacy - Account security, data protection, and preferences
Features:
- Full-text search across all articles
- Category-based navigation
- Related articles suggestions
- FAQ section with common questions
- Troubleshooting guides
- Video tutorials (planned)
- Live chat support integration (planned)

🎨 User Experience Features

Theme & Customization

Dark/Light Modes - Toggle between dark and light themes with system preference detection
Accent Colors - 6 preset themes (Green, Red, Purple, Gold, Cyan, White) with custom colors
Font Size Scaling - Three size levels (Small, Medium, Large) for accessibility
Landing Page Themes - Separate color themes for marketing pages
Responsive Design - Mobile, tablet, and desktop optimized layouts
Smooth Animations - Framer Motion for modern interactions
Accessibility - WCAG 2.1 Level AA compliance, keyboard navigation, screen reader support

Multi-Language Support

Google Translate Integration - Auto-translate content to 100+ languages
Language Persistence - Remember language preference across sessions
RTL Language Support - Right-to-left layout for Arabic, Hebrew, etc.
Custom Translations - Add custom translations for UI elements (planned)

Search & Discovery

Global Search - Search across courses, users, announcements, and documents
Advanced Filters - Filter by department, date, type, and relevance
Search History - View recent searches with quick access
Suggested Results - Auto-complete and search suggestions
Search Analytics - Track popular searches to improve content

🏗️ Architecture Features

1. Role-Based Access Control (RBAC)

6 Distinct Roles: Super Admin, College Admin, Faculty, Student, Placement Officer, Recruiter
Granular Permissions: 50+ permissions for fine-grained access control
Dynamic UI: Features and menus adapt based on user role
Protected Routes: Automatic redirects for unauthorized access
Real-Time Validation: Permission checks at component and API level
Audit Trail: Log all permission-based actions

2. Real-Time Data Synchronization

Firebase Firestore - Real-time NoSQL database with instant updates
Live Notifications - Push notifications via Firebase Cloud Messaging
Optimistic UI - Instant feedback with background sync
Offline Support - Local caching with automatic sync on reconnection
Batch Operations - Multiple updates in single atomic transactions
Change Listeners - Real-time listeners for chat, notifications, and updates

3. Responsive & Accessible Design

Mobile-First Approach - Touch-optimized for all devices
Breakpoints:
- Mobile: 320px - 767px
- Tablet: 768px - 1024px
- Desktop: 1025px - 1440px
- Large Desktop: 1441px+
Accessibility Features:
- WCAG 2.1 Level AA compliance
- Semantic HTML and ARIA labels
- Keyboard navigation support
- Screen reader compatibility
- High contrast modes
- Focus indicators

4. Multi-Organization Support

Organization Isolation - Complete data separation between institutions
Organization Scoping - Auto-filter data by organization
Shared Resources - Option to share courses, materials, and templates
Organization Settings - Independent branding and configuration per organization
Super Admin Control - Manage multiple colleges from single dashboard

🚀 Technology Stack

Category	Technology	Purpose
Framework	React 18 + TypeScript	Modern UI with type safety
Build Tool	Vite with SWC	Fast development and production builds
Styling	Tailwind CSS	Utility-first CSS framework
UI Components	shadcn/ui (55+)	Pre-built accessible components
Routing	React Router v6	Client-side routing with nested routes
Backend	Firebase/Firestore	Real-time database and authentication
Storage	Firebase Storage	File and media storage
AI/ML	Google Gemini 2.5 Flash	AI chatbot and content generation
Icons	Lucide React + Tabler Icons	1000+ SVG icons
Animations	Framer Motion + GSAP	Smooth UI animations and transitions
State Management	React Hooks + Context API	Built-in React state management
Form Handling	React Hook Form + Zod	Form validation and management
Charts	Recharts	Data visualization and analytics
PDF Generation	jsPDF + jsPDF-AutoTable	Document and receipt generation
QR Codes	qrcode.react + html5-qrcode	QR generation and scanning
3D Graphics	Three.js	3D campus map and visualizations
Fonts	Monument Extended, Fraunces, DM Sans	Custom typography

📁 Project Structure

omniflow/
├── public/
│   ├── fonts/                  # Custom fonts (Monument Extended, Fraunces)
│   ├── images/                 # Static images and assets
│   └── favicon.ico             # App favicon
├── src/
│   ├── components/
│   │   ├── layout/
│   │   │   ├── Header.tsx           # Top navigation with search and user menu
│   │   │   ├── Sidebar.tsx          # Left sidebar with role-based navigation
│   │   │   ├── MainLayout.tsx       # Main app layout wrapper
│   │   │   └── Footer.tsx           # Footer component
│   │   ├── ui/                      # shadcn/ui components (55+)
│   │   │   ├── button.tsx
│   │   │   ├── dialog.tsx
│   │   │   ├── card.tsx
│   │   │   └── ... (50+ more)
│   │   ├── animations/              # Animation components
│   │   │   ├── ScrollReveal.tsx
│   │   │   └── Counter.tsx
│   │   ├── attendance/              # Attendance-specific components
│   │   │   ├── QRCodeScanner.tsx
│   │   │   └── AttendanceMarker.tsx
│   │   ├── chat/                    # Chat system components (11 files)
│   │   │   ├── ChatWindow.tsx
│   │   │   ├── MessageList.tsx
│   │   │   ├── GroupList.tsx
│   │   │   └── ...
│   │   ├── common/                  # Reusable components
│   │   │   ├── ExportDialog.tsx
│   │   │   ├── ImportDialog.tsx
│   │   │   ├── ConfirmDialog.tsx
│   │   │   └── BulkUpload.tsx
│   │   ├── timetable/
│   │   │   └── TimetableGrid.tsx
│   │   ├── FloatingAIChat.tsx       # Saathi chatbot component
│   │   ├── GoogleTranslate.tsx      # Translation component
│   │   ├── ProtectedRoute.tsx       # Route protection wrapper
│   │   └── ...
│   ├── pages/
│   │   ├── admin/                   # Admin-only pages (13 files)
│   │   │   ├── CollegeSettings.tsx
│   │   │   ├── PaymentSettings.tsx
│   │   │   ├── CanteenManager.tsx
│   │   │   ├── HostelAdmin.tsx
│   │   │   ├── SystemConfig.tsx
│   │   │   ├── SystemLogs.tsx
│   │   │   ├── Approvals.tsx
│   │   │   ├── Organizations.tsx
│   │   │   ├── OrganizationDetail.tsx
│   │   │   ├── AddOrganization.tsx
│   │   │   ├── PlacementSettings.tsx
│   │   │   ├── PlacementInsights.tsx
│   │   │   └── Recruiters.tsx
│   │   ├── college/                 # College management pages (12 files)
│   │   │   ├── Departments.tsx
│   │   │   ├── DepartmentDetail.tsx
│   │   │   ├── Faculty.tsx
│   │   │   ├── FacultyDetail.tsx
│   │   │   ├── AddFaculty.tsx
│   │   │   ├── AddCourse.tsx
│   │   │   ├── AddUser.tsx
│   │   │   ├── Admissions.tsx
│   │   │   ├── FeeSetup.tsx
│   │   │   ├── FinancialReport.tsx
│   │   │   ├── Reports.tsx
│   │   │   └── Schedule.tsx
│   │   ├── dashboards/              # Dashboard pages (8 files)
│   │   │   ├── AdminDashboard.tsx
│   │   │   ├── StudentDashboard.tsx
│   │   │   ├── FacultyDashboard.tsx
│   │   │   ├── PlacementOfficerDashboard.tsx
│   │   │   ├── RecruiterDashboard.tsx
│   │   │   ├── CollegeAdminDashboard.tsx
│   │   │   └── ...
│   │   ├── placement/               # Placement-related pages (12 files)
│   │   │   ├── Jobs.tsx
│   │   │   ├── PlacementDrives.tsx
│   │   │   ├── PlacementApplications.tsx
│   │   │   ├── PlacementProfile.tsx
│   │   │   ├── MyPlacementDashboard.tsx
│   │   │   ├── CandidateDiscovery.tsx
│   │   │   ├── InterviewSchedule.tsx
│   │   │   ├── OfferManagement.tsx
│   │   │   ├── PlacementReports.tsx
│   │   │   ├── StudentReadiness.tsx
│   │   │   ├── CareerPortal.tsx
│   │   │   └── Recruiters.tsx
│   │   ├── help/                    # Help documentation (4 sections)
│   │   │   ├── HelpArticle.tsx
│   │   │   ├── GettingStarted.tsx
│   │   │   ├── AccountProfile.tsx
│   │   │   └── ...
│   │   ├── LandingPage.tsx          # Marketing landing page
│   │   ├── Auth.tsx                 # Authentication page
│   │   ├── Onboarding.tsx           # User onboarding flow
│   │   ├── Courses.tsx              # Course management
│   │   ├── CourseMaterials.tsx      # Course materials browser
│   │   ├── CourseDetail.tsx         # Individual course view
│   │   ├── Timetable.tsx            # Schedule management
│   │   ├── Attendance.tsx           # Attendance tracking
│   │   ├── Examinations.tsx         # Exam management
│   │   ├── Assignments.tsx          # Assignment tracking
│   │   ├── Finance.tsx              # Fee management
│   │   ├── PaymentDetail.tsx        # Payment transaction details
│   │   ├── Placements.tsx           # Placement overview
│   │   ├── JobDetail.tsx            # Individual job posting
│   │   ├── MyApplications.tsx       # Student applications tracker
│   │   ├── ResumeBuilder.tsx        # Basic resume builder
│   │   ├── ResumeBuilderIvyLeague.tsx # Advanced resume builder
│   │   ├── StudentProfile.tsx       # Student profile management
│   │   ├── PublicStudentProfile.tsx # Public-facing student profiles
│   │   ├── HostelIssues.tsx         # Hostel management
│   │   ├── NightCanteen.tsx         # Canteen ordering
│   │   ├── CampusMap.tsx            # Interactive 3D campus map
│   │   ├── Chat.tsx                 # Chat system
│   │   ├── Clubs.tsx                # Clubs and activities
│   │   ├── Library.tsx              # Library management
│   │   ├── RoomBooking.tsx          # Room booking system
│   │   ├── LeaveManagement.tsx      # Leave applications
│   │   ├── Notifications.tsx        # Notification center
│   │   ├── NotificationDetail.tsx   # Individual notification view
│   │   ├── Users.tsx                # User management
│   │   ├── UserDetail.tsx           # User detail view
│   │   ├── Students.tsx             # Student listing
│   │   ├── Organizations.tsx        # Multi-org management
│   │   ├── Settings.tsx             # User settings
│   │   ├── Help.tsx                 # Help center
│   │   ├── Search.tsx               # Global search
│   │   ├── About.tsx                # About page
│   │   ├── Contact.tsx              # Contact page
│   │   ├── Pricing.tsx              # Pricing page
│   │   ├── Privacy.tsx              # Privacy policy
│   │   ├── Terms.tsx                # Terms of service
│   │   ├── SystemHealth.tsx         # System monitoring
│   │   └── ...
│   ├── hooks/
│   │   ├── useAuth.ts               # Authentication hook
│   │   ├── usePermissions.ts        # Permission checking
│   │   ├── useDepartmentFilter.ts   # Department filtering
│   │   ├── useCollegeSettings.ts    # College settings hook
│   │   ├── useTheme.ts              # Theme management
│   │   ├── useNotifications.ts      # Notifications hook
│   │   ├── useChat.ts               # Chat functionality
│   │   ├── useFirestore.ts          # Firestore helper
│   │   └── ... (12 total)
│   ├── lib/
│   │   ├── firebase.ts              # Firebase initialization
│   │   ├── accessControl.ts         # Access control logic
│   │   ├── permissions.ts           # Permission definitions
│   │   ├── rolePermissions.ts       # Role-based permissions
│   │   ├── utils.ts                 # Utility functions
│   │   ├── cn.ts                    # Class name utilities
│   │   └── ... (16 total)
│   ├── types/
│   │   ├── index.ts                 # TypeScript type definitions
│   │   └── database.ts              # Database schema types
│   ├── config/
│   │   ├── firebase.ts              # Firebase configuration
│   │   └── constants.ts             # App constants
│   ├── contexts/
│   │   └── AuthContext.tsx          # Authentication context
│   ├── utils/
│   │   ├── export.ts                # Export utilities
│   │   ├── validation.ts            # Form validation
│   │   └── formatting.ts            # Data formatting
│   ├── App.tsx                      # Root component with routes
│   ├── main.tsx                     # Application entry point
│   └── index.css                    # Global styles
├── scripts/
│   ├── initDB.js                    # Database initialization
│   └── ... (16 total scripts)
├── firestore.rules                  # Firestore security rules
├── package.json                     # Dependencies and scripts
├── vite.config.ts                   # Vite configuration
├── tailwind.config.ts               # Tailwind CSS configuration
├── tsconfig.json                    # TypeScript configuration
├── README.md                        # This file
├── FEATURES.md                      # Detailed features documentation
├── ARCHITECTURE.md                  # Architecture deep dive
└── QUICK_REFERENCE.md               # Quick reference guide

**Total Files**: 233+ TypeScript/React components
**Total Lines of Code**: 50,000+ (estimated)

🚀 Getting Started

Prerequisites

Node.js v18 or higher
npm or bun package manager
Firebase account (for backend services)
Google Gemini API key (for AI features)

Installation

# Clone the repository
git clone <repository-url>
cd omniflow

# Install dependencies
npm install
# or
bun install

# Set up environment variables
# Create .env.local file with:
VITE_FIREBASE_API_KEY=your_firebase_api_key
VITE_FIREBASE_AUTH_DOMAIN=your_auth_domain
VITE_FIREBASE_PROJECT_ID=your_project_id
VITE_FIREBASE_STORAGE_BUCKET=your_storage_bucket
VITE_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
VITE_FIREBASE_APP_ID=your_app_id
VITE_GEMINI_API_KEY=your_gemini_api_key

# Initialize database (optional)
npm run db:init

# Start development server
npm run dev
# or
bun run dev

Access the application at http://localhost:5173

Production Build

# Build for production
npm run build
# or
bun run build

# Preview production build
npm run preview

📊 Database Schema

Core Collections

users

{
  id: string;                    // Auto-generated user ID
  email: string;                 // User email (unique)
  name: string;                  // Full name
  role: UserRole;                // User role (student, faculty, admin, etc.)
  organizationId?: string;       // Organization reference (multi-org)
  department?: string;           // Department reference
  photoURL?: string;             // Profile photo URL
  phone?: string;                // Contact number
  createdAt: Timestamp;          // Account creation date
  lastLogin?: Timestamp;         // Last login timestamp
  isActive: boolean;             // Account status
  permissions: string[];         // Array of permission keys
}

courses

{
  id: string;
  name: string;
  code: string;                  // Course code (e.g., CS101)
  department: string;            // Department reference
  credits: number;               // Credit hours
  semester: number;              // Semester number
  year: number;                  // Academic year
  facultyId: string;             // Faculty reference
  syllabus?: string;             // Syllabus document URL
  materials: {                   // Course materials
    type: 'note' | 'assignment' | 'paper';
    title: string;
    url: string;
    uploadedAt: Timestamp;
  }[];
  enrolledStudents: string[];    // Array of student IDs
  organizationId: string;        // Organization reference
  createdAt: Timestamp;
}

attendance

{
  id: string;
  courseId: string;              // Course reference
  date: Timestamp;               // Attendance date
  markedBy: string;              // Faculty ID who marked
  students: {                    // Student attendance map
    [studentId: string]: {
      present: boolean;
      markedAt: Timestamp;
    }
  };
  qrCode?: string;               // QR code for quick marking
  organizationId: string;
}

assignments

{
  id: string;
  courseId: string;
  title: string;
  description: string;
  dueDate: Timestamp;
  totalMarks: number;
  attachments: string[];         // File URLs
  createdBy: string;             // Faculty ID
  submissions: {
    [studentId: string]: {
      submittedAt: Timestamp;
      files: string[];
      grade?: number;
      feedback?: string;
    }
  };
  organizationId: string;
  createdAt: Timestamp;
}

jobs

{
  id: string;
  title: string;
  company: string;
  description: string;
  requirements: string[];
  salary: {
    min: number;
    max: number;
    currency: string;
  };
  location: string;
  type: 'full-time' | 'part-time' | 'internship';
  skills: string[];
  eligibility: {
    minCGPA: number;
    departments: string[];
    graduationYear: number[];
  };
  applications: string[];        // Student IDs
  postedBy: string;              // Recruiter/TPO ID
  status: 'open' | 'closed';
  deadline: Timestamp;
  organizationId: string;
  createdAt: Timestamp;
}

fees

{
  id: string;
  studentId: string;
  academicYear: string;
  semester: number;
  feeStructure: {
    tuition: number;
    library: number;
    lab: number;
    sports: number;
    misc: number;
  };
  totalAmount: number;
  paidAmount: number;
  dueAmount: number;
  payments: {
    id: string;
    amount: number;
    method: string;
    transactionId: string;
    paidAt: Timestamp;
    receiptUrl?: string;
  }[];
  dueDate: Timestamp;
  organizationId: string;
}

chatRooms

{
  id: string;
  type: 'group' | 'direct';
  name?: string;                 // For groups
  description?: string;
  participants: string[];        // User IDs
  admins: string[];              // Group admin IDs
  organizationId: string;
  department?: string;           // For department groups
  semester?: number;             // For semester groups
  createdBy: string;
  createdAt: Timestamp;
  lastMessage?: {
    text: string;
    sentBy: string;
    sentAt: Timestamp;
  };
}

messages

{
  id: string;
  roomId: string;                // Chat room reference
  text: string;
  sentBy: string;                // User ID
  sentAt: Timestamp;
  readBy: string[];              // User IDs who read the message
  attachments?: {
    type: 'image' | 'document' | 'file';
    url: string;
    name: string;
  }[];
  replyTo?: string;              // Message ID being replied to
  reactions?: {
    [emoji: string]: string[];   // User IDs who reacted
  };
}

Additional Collections

notifications - User notifications and announcements
hostelIssues - Hostel issue tracking
canteenOrders - Food orders from night canteen
roomBookings - Facility bookings
leaveApplications - Leave requests and approvals
placementDrives - Campus recruitment drives
resumes - Student resume versions
libraries - Library books and lending records
clubs - Student clubs and activities
collegeSettings - Institutional branding and configuration
organizations - Multi-organization support

👥 User Roles & Capabilities

Student

✅ View courses, materials, and syllabus
✅ Track attendance and grades
✅ Submit assignments and view feedback
✅ Register for placement drives and apply to jobs
✅ Build and analyze resumes
✅ Report hostel issues and order from canteen
✅ View fees and make online payments
✅ Join clubs and register for events
✅ Apply for leave and track approvals
✅ Chat with peers and faculty
✅ Receive real-time notifications
✅ Customize theme and preferences

Faculty

✅ Create and manage courses
✅ Upload course materials and syllabus
✅ Mark attendance (QR code or manual)
✅ Create assignments and grade submissions
✅ Schedule exams and publish grades
✅ View student performance and analytics
✅ Manage timetables
✅ Approve leave applications
✅ Chat with students and colleagues
✅ Conduct mock interviews
✅ Write recommendations

College Admin

✅ Manage departments and faculty
✅ Configure fee structures
✅ View financial reports and analytics
✅ Manage hostel and canteen operations
✅ Configure payment gateways
✅ Monitor system health
✅ Approve critical workflows
✅ Manage users and permissions
✅ Access all reports and analytics
✅ Configure college branding and settings

Placement Officer (TPO)

✅ Post jobs and recruitment drives
✅ Review and shortlist candidates
✅ Schedule interviews and coordinate recruiters
✅ Track placement statistics and trends
✅ Manage recruiter accounts
✅ Configure placement settings and eligibility
✅ Generate placement reports
✅ Monitor student readiness
✅ Conduct career counseling
✅ Organize pre-placement training

Recruiter

✅ Post job openings and internships
✅ Search and discover candidates
✅ View student profiles and resumes
✅ Shortlist and schedule interviews
✅ Track hiring pipeline
✅ Send offers and manage acceptances
✅ View placement drive schedules
✅ Access candidate analytics
✅ Message placement officer

Super Admin

✅ Manage multiple organizations
✅ System-wide configuration
✅ User management across all orgs
✅ Access all administrative features
✅ Configure integrations and APIs
✅ Monitor system health and logs
✅ Backup and restore data
✅ Security and access control
✅ Billing and subscription management (planned)

🔒 Authentication & Security

Authentication Methods

Email/Password - Secure Firebase Authentication
Session Management - Auto-logout on token expiration
Password Recovery - Email-based password reset
2FA - Two-factor authentication (planned)
OAuth - Google, Microsoft login (planned)

Security Measures

Role-Based Access Control (RBAC) - Granular permission system
Firestore Security Rules - Database-level access control
Data Encryption - HTTPS in transit, encryption at rest
Input Validation - Zod schema validation on all forms
XSS Protection - Sanitized user inputs
CSRF Tokens - Cross-site request forgery protection
Rate Limiting - API rate limiting (planned)
Audit Logs - Complete user activity tracking
Environment Variables - Secure API key management
PCI-DSS Compliance - For payment processing

🎯 Roadmap & Upcoming Features

Q1 2026 (Planned)

Q2 2026 (Planned)

Q3 2026 (Planned)

Future (Backlog)

📈 Performance & Optimization

Current Optimizations

Code Splitting - Route-based lazy loading with React.lazy
Tree Shaking - Eliminate unused code in production
Image Optimization - Responsive images with lazy loading
CSS Optimization - Tailwind CSS with PurgeCSS
Cache Strategies - Service workers for offline support (planned)
CDN Delivery - Static assets via CDN
Gzip Compression - Compressed assets for faster loading
Indexed Queries - Optimized Firestore queries and indexes
Virtual Scrolling - For large lists and tables
Debounced Search - Reduce API calls on search inputs

Performance Metrics (Target)

First Contentful Paint (FCP): < 1.5s
Largest Contentful Paint (LCP): < 2.5s
Time to Interactive (TTI): < 3.5s
Cumulative Layout Shift (CLS): < 0.1
Bundle Size: < 300KB (gzipped)
Lighthouse Score: 90+ (Performance, Accessibility, Best Practices, SEO)

🌐 Browser & Device Support

Browsers

✅ Chrome/Edge (latest 2 versions)
✅ Firefox (latest 2 versions)
✅ Safari (latest 2 versions)
✅ Chrome Mobile (latest)
✅ Safari iOS (latest)
⚠️ IE11 (not supported)

Devices

✅ Desktop (Windows, macOS, Linux)
✅ Tablets (iPad, Android tablets)
✅ Mobile phones (iOS 13+, Android 8+)
✅ Touch and mouse support
✅ Responsive layouts for all screen sizes

🛠️ Development

Available Commands

# Development
npm run dev          # Start dev server with hot reload (port 5173)
npm run api          # Start local API server (for testing)
npm run dev:all      # Run both dev server and API server

# Database
npm run db:init      # Initialize database with sample data

# Build
npm run build        # Production build
npm run build:dev    # Development build
npm run preview      # Preview production build

# Code Quality
npm run lint         # Run ESLint
npm run lint:fix     # Auto-fix linting issues (if available)

Environment Variables

Create .env.local file:

# Firebase Configuration
VITE_FIREBASE_API_KEY=your_firebase_api_key
VITE_FIREBASE_AUTH_DOMAIN=your_auth_domain
VITE_FIREBASE_PROJECT_ID=your_project_id
VITE_FIREBASE_STORAGE_BUCKET=your_storage_bucket
VITE_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
VITE_FIREBASE_APP_ID=your_app_id

# AI Services
VITE_GEMINI_API_KEY=your_gemini_api_key

# Optional
VITE_APP_ENV=development
VITE_API_BASE_URL=http://localhost:3000

Code Quality Tools

ESLint - Code linting and style enforcement
TypeScript Strict Mode - Type safety
Prettier - Code formatting (add if needed)
Husky - Git hooks for pre-commit validation (planned)

🚀 Deployment

Deploy to Vercel

# Install Vercel CLI
npm i -g vercel

# Deploy
vercel

Deploy to Netlify

# Install Netlify CLI
npm i -g netlify-cli

# Deploy
netlify deploy --prod

Deploy to Firebase Hosting

# Install Firebase CLI
npm i -g firebase-tools

# Login
firebase login

# Initialize (one-time)
firebase init hosting

# Deploy
firebase deploy --only hosting

Environment Variables for Production

Set the following in your deployment platform:

VITE_FIREBASE_API_KEY
VITE_FIREBASE_AUTH_DOMAIN
VITE_FIREBASE_PROJECT_ID
VITE_FIREBASE_STORAGE_BUCKET
VITE_FIREBASE_MESSAGING_SENDER_ID
VITE_FIREBASE_APP_ID
VITE_GEMINI_API_KEY

📝 Contributing

Contributions are welcome! Please follow these guidelines:

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

Coding Standards

Use TypeScript for all new files
Follow existing code structure and naming conventions
Write meaningful commit messages
Add comments for complex logic
Ensure no linting errors
Test your changes thoroughly

📄 License

💬 Support

For help and support:

In-App Help: Access the Help & Support section with 40+ articles
Documentation: See FEATURES.md and ARCHITECTURE.md for detailed information
Email: Contact your institution's support team
Feature Requests: Submit feedback through the application

🏆 Achievements

⭐ 50,000+ Lines of Code - Comprehensive feature-rich platform
⭐ 6 User Roles - Complete RBAC implementation
⭐ 100+ Pages/Components - Extensive UI coverage
⭐ Real-Time Sync - Instant updates across all clients
⭐ Mobile-Responsive - Works seamlessly on all devices
⭐ AI-Powered - Dual chatbots with Google Gemini
⭐ 40+ Help Articles - Comprehensive documentation
⭐ Multi-Organization - Support for multiple institutions
⭐ WhatsApp-Grade Chat - Professional messaging system
⭐ 3D Campus Map - Interactive campus navigation

🎨 Screenshots & Demo

(Coming Soon - Add screenshots of key features)

🔗 Related Documentation

FEATURES.md - Comprehensive feature documentation
ARCHITECTURE.md - Technical architecture deep dive
QUICK_REFERENCE.md - Quick reference guide

Built with ❤️ for educational institutions

Version: 1.0.0
Last Updated: January 2026
Maintainers: OmniFlow Development Team

Name		Name	Last commit message	Last commit date
Latest commit History 38 Commits
public		public
scripts		scripts
src		src
.env.example		.env.example
.gitignore		.gitignore
ARCHITECTURE.md		ARCHITECTURE.md
DEVELOPMENT.md		DEVELOPMENT.md
FEATURES.md		FEATURES.md
QUICK_REFERENCE.md		QUICK_REFERENCE.md
README.md		README.md
components.json		components.json
eslint.config.js		eslint.config.js
firestore.rules		firestore.rules
hi.txt		hi.txt
index.html		index.html
package-lock.json		package-lock.json
package.json		package.json
postcss.config.js		postcss.config.js
tailwind.config.ts		tailwind.config.ts
tsconfig.app.json		tsconfig.app.json
tsconfig.json		tsconfig.json
tsconfig.node.json		tsconfig.node.json
vite.config.ts		vite.config.ts

Folders and files

Latest commit

History

Repository files navigation