Skip to content

sarangoki/IntelliClass

Repository files navigation

IntelliClass Banner

IntelliClass

Smart Classroom Management System

A modern AI-powered classroom management platform built using React, TypeScript, Firebase, and Gemini AI.


πŸ“Œ Overview

IntelliClass is a smart classroom and academic management web application developed to simplify communication, academic tracking, and administration inside educational institutions.

The platform provides separate dashboards for students, faculty members, HODs, and administrators with role-based access and cloud database integration.


πŸš€ Features

πŸ‘¨β€πŸŽ“ Student Dashboard

  • View grades and academic records
  • Access course details
  • Manage profile information
  • Real-time communication system
  • Performance analytics

πŸ‘¨β€πŸ« Faculty Dashboard

  • Student management
  • Academic monitoring
  • Communication tools
  • Dashboard analytics

🏫 Admin / HOD Dashboard

  • User role management
  • Department monitoring
  • Academic overview
  • Administrative controls

πŸ€– AI Integration

  • Gemini AI-powered features
  • Smart educational assistance
  • AI-driven workflow support

πŸ› οΈ Tech Stack

Technology Purpose
React Frontend development
TypeScript Type safety
Vite Build tool
Firebase Authentication User authentication
Firestore Database Cloud database
Tailwind CSS UI styling
Gemini AI AI-powered functionality

πŸ“‚ Project Structure

src/
 β”œβ”€β”€ components/
 β”œβ”€β”€ pages/
 β”œβ”€β”€ dashboard/
 β”œβ”€β”€ context/
 β”œβ”€β”€ lib/
 β”œβ”€β”€ chat/
 └── assets/

βš™οΈ Installation & Setup

Prerequisites

Make sure the following are installed:

  • Node.js
  • npm

πŸ”§ Run Locally

1️⃣ Clone Repository

git clone https://github.com/sarangoki/IntelliClass.git

2️⃣ Navigate to Project Folder

cd IntelliClass

3️⃣ Install Dependencies

npm install

4️⃣ Create Environment File

Create a file named:

.env.local

Add your Gemini API key:

GEMINI_API_KEY=your_api_key_here

5️⃣ Run Development Server

npm run dev

Application will run at:

http://localhost:3000

πŸ”₯ Firebase Configuration

This project uses Firebase services for:

  • Authentication
  • Firestore Database
  • Cloud connectivity

Update Firebase configuration inside:

firebase-applet-config.json

πŸ“¦ Build for Production

npm run build

🌐 Deployment

This project can be deployed using:

  • Vercel
  • Netlify
  • Firebase Hosting

πŸ“Έ Screenshots

Add project screenshots here.


πŸ“– Learning Objectives

This project demonstrates:

  • Modern React architecture
  • Cloud database integration
  • Role-based authentication
  • AI integration using Gemini
  • Frontend application development

πŸ‘¨β€πŸ’» Author

Gokul Nath S

GitHub: https://github.com/sarangoki


πŸ“„ License

This project is developed for educational and learning purposes.

Releases

No releases published

Packages

 
 
 

Contributors

Languages