🎓 Learnova

AI-Powered Smart Student Engagement & Attendance Platform

Transforming Education — One Institution at a Time

---

🌟 What is Learnova?

Learnova is a modern, AI-powered educational platform built to eliminate the inefficiencies of traditional school management. It replaces manual attendance, siloed data, and disengaged learning with a seamless, integrated experience for every stakeholder in education.

• 🧑‍🏫 Teachers regain ~1 hour/day — more time to teach, less time on admin
• 🎒 Students convert ~90+ hours/year of idle time into productive learning
• 🏫 Institutions improve attendance metrics and engagement across departments
• 👨‍👩‍👧 Parents gain transparent, real-time insights into their child's progress

---

✨ Features

🔐 Role-Based Authentication

• Separate dashboards for Students, Teachers, Institutes, Parents, and Admins
• Firebase-powered sign-up/login with email verification and password reset
• Secure protected routes with role-based redirects

📸 Face Recognition Attendance

• AI-powered face recognition using Face API.js for contactless attendance
• Attendance validation and conflict resolution built-in
• Reduces manual roll-call time dramatically

📊 Role-Specific Dashboards

• Student Dashboard — view attendance records and academic progress
• Teacher Dashboard — manage classes, take attendance, monitor students
• Institute Dashboard — oversee departments and institution-wide metrics
• Parent Dashboard — monitor linked children's daily/weekly/monthly attendance trends, grades breakdown, low attendance alerts, and announcements
• Admin Dashboard — full system administration and user management

📋 Notice Board

• Institution-wide announcements and notices for all roles
• Real-time updates accessible across dashboards

📅 Activity Centre

• Track academic and co-curricular activities
• Centralised log accessible to students and teachers

🤖 AI Chatbot

• Built-in Learnova chatbot for platform assistance
• Available globally across all pages

📱 Progressive Web App (PWA)

• Installable on any device — mobile or desktop
• Works in low-network environments for maximum accessibility

📬 Contact & Communication

• Integrated contact form powered by EmailJS
• Direct communication channel between users and the Learnova team

⚙️ Profile & Settings

• Universal profile management for all roles
• Customisable settings per user type

---

👨‍👩‍👧 Parent Portal Feature

Learnova features a comprehensive Parent Portal that allows parents to securely monitor their children's academic status, notifications, and attendance.

Key Capabilities

1. Parent-Student Linking: Admins can securely link one or multiple student accounts to a single Parent account via the Admin Dashboard.
2. Attendance Tracking: Dynamic attendance analytics displaying daily, weekly, and monthly trends using high-fidelity Recharts visualisations.
3. Academic Performance: Subject-wise grade breakdown, scores, and GPAs with automatic grade notifications.
4. Self-Healing Low Attendance Alerts: Automated background check triggers when student attendance drops below 75%, generating notifications for parents.
5. Notice Board Integration: Parents can view notices and announcements posted by the student's institute.

Data Schemas

parent_student_links (Firestore & MongoDB)

Maps the relationship between a parent and their linked child/children:

• _id / documentId: ${parentId}_${studentId}
• parentId: Firebase UID of the parent user
• studentId: Firebase UID of the student user
• createdAt: ISO Timestamp

grades (Firestore & MongoDB)

Stores subject-wise student grades:

• _id / documentId: Unique ID
• studentId: Firebase UID of the student user
• subject: Name of the subject (e.g. "Computer Science")
• grade: Letter grade (e.g. "A+")
• score: Numeric score (e.g. 98)
• maxScore: Maximum possible score (e.g. 100)
• term: Academic term (e.g. "Midterm")
• date: Grading date (e.g. "2026-06-01")
• createdAt: ISO Timestamp

---

🛠️ Tech Stack

Layer	Technology
Framework	Next.js 15 (App Router)
UI Library	React 19
Styling	Tailwind CSS v4
Animations	Framer Motion, GSAP
Authentication	Firebase Auth
Database	MongoDB
File Storage	Vercel Blob
Face Recognition	Face API.js
Email	EmailJS
Analytics	Firebase Analytics
PWA	@ducanh2912/next-pwa
Notifications	React Hot Toast

---

📁 Project Structure

learnova/
├── app/
│   ├── page.js                   # Landing / About page
│   ├── layout.js                 # Root layout with metadata & providers
│   ├── auth/                     # Sign in / Sign up
│   ├── verify/                   # Email verification
│   ├── register/                 # New user registration
│   ├── profile/                  # Profile setup
│   ├── student/dashboard/        # Student dashboard
│   ├── teacher/dashboard/        # Teacher dashboard
│   ├── institute/dashboard/      # Institute dashboard
│   ├── parent/dashboard/         # Parent dashboard
│   ├── admin/dashboard/          # Admin dashboard
│   ├── attendance/               # Attendance management
│   ├── activity/                 # Activity centre
│   ├── notices/                  # Notice board
│   ├── settings/                 # User settings
│   └── contact/                  # Contact page
│
├── components/
│   ├── AuthForm.js               # Authentication form
│   ├── RoleSelection.js          # Role selection UI
│   ├── FaceRecognizer.js         # Face recognition component
│   ├── AttendanceValidation.js   # Attendance validation logic
│   ├── StudentDashboard.js       # Student dashboard component
│   ├── TeacherDashboardComponent.js # Teacher dashboard component
│   ├── InstituteDashboard.js     # Institute dashboard
│   ├── ParentDashboard.js        # Parent dashboard component
│   ├── AdminDashboard.js         # Admin dashboard
│   ├── ChatBot.js                # AI chatbot
│   ├── noticeBoard.js            # Notice board component
│   ├── Navbar.js                 # Navigation
│   ├── ProtectedRoute.js         # Route protection
│   ├── InstallPWA.js             # PWA install prompt
│   └── profile.js / settings.js  # Profile & settings
│
├── constants/
│   └── userRoles.js              # Role definitions and config
│
├── contexts/
│   └── AuthContext.js            # Global auth state
│
├── hooks/
│   └── useAuth.js                # Authentication hook
│
├── services/
│   └── authService.js            # Firebase auth service
│
├── utils/
│   └── authUtils.js              # Auth utility functions
│
└── lib/
    └── firebaseConfig.js         # Firebase configuration

---

🚀 Getting Started

Prerequisites

• Node.js 18+
• A Firebase project (Auth + Analytics enabled)
• A MongoDB instance (local or Atlas)
• A Vercel Blob store (for file uploads)

1. Clone the repository

git clone [https://github.com/Premshaw23/Learnova.git](https://github.com/Premshaw23/Learnova.git)
cd Learnova

2. Install dependencies

npm install

3. Configure environment variables

A .env.example file is included in the repo with all required keys. Copy it first:

cp .env.example .env.local

Then fill in your actual values:

# Firebase
NEXT_PUBLIC_FIREBASE_API_KEY=your_api_key
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_auth_domain
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_storage_bucket
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id
NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id
NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=your_measurement_id

# MongoDB
MONGODB_URI=your_mongodb_connection_string

# Vercel Blob
BLOB_READ_WRITE_TOKEN=your_vercel_blob_token

# EmailJS
NEXT_PUBLIC_EMAILJS_SERVICE_ID=your_service_id
NEXT_PUBLIC_EMAILJS_TEMPLATE_ID=your_template_id
NEXT_PUBLIC_EMAILJS_USER_ID=your_user_id
NEXT_PUBLIC_CONTACT_RECEIVER_EMAIL=your-actual-admin-email@example.com
NEXT_PUBLIC_CONTACT_RECEIVER_NAME=Learnova Administration

4. Run the development server

By default, Next.js starts the development server on port 3000. Run the server using:

npm run dev

Open http://localhost:3000 in your browser.

---

🛠️ Troubleshooting

npm install fails

• Use Node.js 18+ (node -v).
• Delete node_modules and package-lock.json, then run npm install again.
• On Apple Silicon, if native modules fail, try npm install --legacy-peer-deps.

Missing or incorrect environment variables

• Ensure .env.local exists in the project root (not committed to git).
• Restart the dev server after changing env vars — Next.js only reads them at startup.
• Verify Firebase keys match your Firebase console project settings.

Firebase auth / configuration errors

• Confirm Email/Password sign-in is enabled in Firebase Authentication.
• Check that NEXT_PUBLIC_FIREBASE_* values are complete and have no trailing spaces.
• For local testing, add localhost to Firebase authorized domains if redirects fail.

Port already in use (EADDRINUSE)

• Another process may be using port 3000. Stop it or run npm run dev -- -p 3001.
• On macOS/Linux: lsof -i :3000 to find the blocking process.

Dev server or build failures

• Clear the Next.js cache: rm -rf .next then npm run dev.
• Run npm run build locally to surface TypeScript or lint errors before deploying.
• Check the terminal for missing MONGODB_URI or Firebase errors on API routes.

MongoDB connection issues

• Confirm MONGODB_URI includes the database name and valid credentials.
• For Atlas, allow your current IP in Network Access and verify the cluster is running.

---

5. Build for production

npm run build
npm run start

---

🌐 Deployment

Learnova is deployed on Vercel. To deploy your own instance:

1. Push your code to GitHub
2. Import the repository on vercel.com
3. Add all environment variables in the Vercel dashboard
4. Deploy — Vercel handles the rest

Live at: https://learnova-web.vercel.app

---

👥 Meet the Team

Name	Role
Prem Shaw	Founder & Creator — Team Leader, Full-Stack Developer
Prashant Bhati	Web Developer
Polawar Pranav Shirish	Frontend Developer
Abir Ghosh	Machine Learning Specialist
Anuj Ram Shrivastava	ML & Backend Developer
Chandana S	Testing & Documentation

---

💡 Our Values

Value	Description
⚡ Efficiency	Streamline workflows and reduce redundancy so educators can focus on teaching
💜 Engagement	Interactive and gamified experiences that motivate students
🌍 Accessibility	Designed for all schools, even in low-network areas, with affordable solutions

---

📄 License

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

You are free to use, modify, and distribute this software commercially or personally, as long as you include the license and original copyright notice.

---

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for:

• How to report bugs
• Feature request guidelines
• Development setup instructions
• Code style standards
• Pull request process

⚠️ Contribution Limits

To maintain repository quality and ensure fair visibility for all contributors, please note:

Per-Contributor Limits:

• Maximum 3 open Issues per contributor at a time
• Maximum 3 open PRs per contributor at a time

Repository-Wide Limit:

• Maximum 30 open PRs total in the repository at any time

Why these limits?

• Encourages focused, high-quality work
• Reduces spam and duplicate submissions
• Ensures maintainers can review thoroughly
• Gives all contributors fair visibility
• Keeps repository manageable and organized

Before opening new Issues/PRs: ✅ Close or merge previous open work
✅ Ensure proper testing and documentation
✅ Focus on quality over quantity

---

📋 Code of Conduct

Please read our Code of Conduct before participating.

---

🔒 Security

Found a security vulnerability? Please report it responsibly to security@learnova.com instead of opening a public issue. See SECURITY.md for details.

---

👥 Contributors

Prem Shaw	@ionfwsrijan	@mrdeyroy	@pithva007	@atul-upadhyay-7
@Prateek2007-cmd	@Aditya8369	@RUSHILPATEL33	@nivedha2025cse-gif	@Hrithik-ui753
@Siddh2024	@Srushti-Kamble14	@sanrishi	@HarshaNaidu11	@pranav-cholleti
@sricharan-213	@Pratyush-Panda-2006	@Vaishnav-Hub9	@basantnema31	@prakshithamalla-art
@DhruvalBhinsara1	@KRUSHAL2956	@nancy-verma780	@Sandeep6135	@Chakshu-Bamotra
@leno23	@codedbydollys10	@akashgoudsidduluri	@pragya0129	@dynamo-pentester
@anshul23102	@PRODHOSH	@omnipotentchaos	@paripnj	@Divyanshu227
@AMAN194701	@tamannaa-rath	@Ayushh-Sharmaa	@suhaniiz	@anshika1179
@harshbok69-bit	@siddharth277	@SuhridXSingh	@Sweksha-Kakkar	@skypank-coder
@vedant7007	@Pratikshya32	@thevaibhavtyagi	@KGFCH2	@NiranjanDoijode23
@PanditG4303	@advikdivekar	@yuvraj-k-singh	@jainiksha	@leonagoel
@vaishnavijha12	@Arhanabdullah	@Julliet-Mohanta	@DebasmitaBose0	@Shanidhya01
@nimkarprachi17	@SOHALIYAJAY	@Nihal-Reddy-K	@hitdepani	@Dhyeya29
@thakurakanksha288	@AdityaNarayanPadhi	@Vaghasiya-Jemit-kanaiyalal	@varun29sharma	@kanishka-2007-tech
@Meenbudha	@dhiraj-dev-19	@Ayushia5	@4nshhh	@Tanish-Solanki
@PradeepTech-hub	@pericharlabindhumadhavi-data	@udaycodespace	@Shrutiii01	@namrarafique93-del
@pracheyyy	@adityayadav176	@knoxiboy	@zairahussain27	@Vikrant0207
@tanishksinha	@Shayan-Bhowmik	@NiravaM	@VishnuVardhanCodes	@paridhijain153
@Animesh-86	@anujsharma8d	@ishitaajain22-tech	@khushi897920-lang	@priyanshi-coder-2
@the-rahul-07	@Copilot	@riddhimagupta2	@Rajal-ui	@Hiral-Barot
@pari-dubey1	@shauryaparth1902-blip	@surya0904shankar	@tanishrajh	@shruti-codes-design
@parakramgambhir2025	@Bhavex	@AdityaSekharDas	@adityack477	@Neel-Aiprog
@Nazia012	@Asifmd45	@Prashantbhati7	@ssuyashhhh	@vaishalig03
@ash1shkumar	@dchokshi28	@Kritika200520	@Shashank-8p	@Smrithi-krishna
@Subham503	@Yashrajsinh-Kanchva	@ziyakhan04	@mxskaaan	@oshin-30
@sujal-rana58	@aaradhyasinghai-ux	@Abhii-afk	@vansh-09	@Sha-lini3
@shreyasingh260	@dhruv-jani-0808	@ApekshaRao27	@Ankitkr16	@gowthamrdyy
@HarmiBhikadiya	@Ketandora	@KhushiYadav-26	@Kokila-chandrakar	@saniya196
@rajesh-puripanda	@parakramgambhir14	@Owais-Siddique-11	@Nirmai-06	@Nilamma19
@kannatinaveena	@Meera2906	@Lishhhh07	@pratyuxxhh	@Tannie02
@Thejaswini-VS	@UTKARSHH20	@vikasverma101	@VikashRaj110	@Vinuthnainti
@AnxhDarji	@indreshgit10	@karthick7204	@nisha-bugalia	@nishitha011
@pratikshasuryawanshi843-ui	@Sagun-Bajpai	@sarthakshruti999-code	@shambhavivartika06-cmyk	@suhanimaurya05
@lover3123	@workwithme67	@yashvi-3106	@Achiever199	@aishwary-vansh
@Anshika-Gupta9	@ARCHITVARMA15	@Dippp10-ally	@Hussain053	@krishsoni-hub
@LalithMadhav-CODING	@Bhavikapatel06	@PojashriJM	@Pragya005	@pritesh-4
@priya434960	@Chaudhary8587	@SARTHAKJINDAL1	@Sanjay452656	@SatyajeetSahoo08
@savniagrawal1701	@Shrutii-Rai	@Shrutika-Dahale

---

🏗️ System Architecture Blueprint

Want to learn more about how Learnova's underlying technology behaves under the hood? Read our detailed, Mermaid-enhanced System Architecture Guide to understand routing middleware verification, neural network face detection thresholds, and offline PWA queues.

🛠️ Documentation Improvements

• Add badges (optional): build, license, contributors
• Add screenshots for better UI understanding
• Standardize code blocks for commands

🎯 Goal

Improve onboarding experience for new contributors and users by making README more structured, readable, and professional.

|
@AdityaSekharDas |
@adityayadav176 |
@adityack477 |
@Nazia012 |
@dchokshi28 |

@ash1shkumar

GSSoC Attendance Passcode Masking Guidelines

• Always mask attendance code states internally.