🎓 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, 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
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

🛠️ 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
│   ├── 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
│   ├── 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

▶️

Windows(or any OS) with pnpm

pnpm 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:

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

/**

✨ README Improvement Notes

📌 Formatting Enhancements Needed

Improve heading hierarchy for better readability
Ensure consistent spacing between sections
Use proper Markdown formatting for code blocks and lists
Align all installation and usage steps properly

🚀 Suggested Structure Upgrade

Introduction
Features
Tech Stack
Installation
Usage
Project Structure
Contribution Guidelines
License

🛠️ 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. */

GSSoC Attendance Passcode Masking Guidelines

Always mask attendance code states internally.

Name		Name	Last commit message	Last commit date
Latest commit History 3,430 Commits
.github		.github
app		app
components		components
constants		constants
contexts		contexts
data		data
docs		docs
hooks		hooks
i18n		i18n
lib		lib
locales		locales
messages		messages
middleware/__tests__		middleware/__tests__
public		public
services		services
testUtils		testUtils
tests		tests
utils		utils
worker		worker
.editorconfig		.editorconfig
.env.example		.env.example
.eslintrc.json		.eslintrc.json
.gitattributes		.gitattributes
.gitignore		.gitignore
.nvmrc		.nvmrc
.prettierignore		.prettierignore
.prettierrc		.prettierrc
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
NOTICE_BOARD_IMPLEMENTATION.md		NOTICE_BOARD_IMPLEMENTATION.md
README.md		README.md
eslint.config.mjs		eslint.config.mjs
firestore.indexes.json		firestore.indexes.json
jest.config.mjs		jest.config.mjs
jest.custom.config.js		jest.custom.config.js
jest.setup.js		jest.setup.js
jsconfig.json		jsconfig.json
middleware.js		middleware.js
next.config.mjs		next.config.mjs
package-lock.json		package-lock.json
package.json		package.json
postcss.config.mjs		postcss.config.mjs
vercel.json		vercel.json
vitest.config.js		vitest.config.js

Folders and files

Latest commit

History

Repository files navigation

🎓 Learnova

AI-Powered Smart Student Engagement & Attendance Platform

🌟 What is Learnova?

✨ Features

🔐 Role-Based Authentication

📸 Face Recognition Attendance

📊 Role-Specific Dashboards

📋 Notice Board

📅 Activity Centre

🤖 AI Chatbot

📱 Progressive Web App (PWA)

📬 Contact & Communication

⚙️ Profile & Settings

🛠️ Tech Stack

📁 Project Structure

🚀 Getting Started

Prerequisites

1. Clone the repository

2. Install dependencies

3. Configure environment variables

4. Run the development server

🛠️ Troubleshooting

npm install fails

Missing or incorrect environment variables

Firebase auth / configuration errors

Port already in use (EADDRINUSE)

Dev server or build failures

MongoDB connection issues

5. Build for production

🌐 Deployment

👥 Meet the Team

💡 Our Values

📄 License

🤝 Contributing

⚠️ Contribution Limits

📋 Code of Conduct

🔒 Security

👥 Contributors

✨ README Improvement Notes

📌 Formatting Enhancements Needed

🚀 Suggested Structure Upgrade

🛠️ Documentation Improvements

🎯 Goal

GSSoC Attendance Passcode Masking Guidelines

About

Resources

License

Code of conduct

Contributing

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

`npm install` fails

Port already in use (`EADDRINUSE`)

Packages