Skip to content

Mahbub2001/EduOrbit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

49 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŒŒ EduOrbit AI

Next-Gen, AI-Powered Exam Preparation Platform

An intelligent, bilingual (English ๐Ÿ‡ฌ๐Ÿ‡ง / Bangla ๐Ÿ‡ง๐Ÿ‡ฉ) learning ecosystem that adapts to every learner โ€” from Class 1โ€“12 to admission tests, government jobs, and skill development.

Next.js React TypeScript Tailwind CSS Firebase Genkit AI


EduOrbit AI โ€” Landing Page


๐Ÿ“– Overview

EduOrbit AI is the frontend of a modern exam-preparation platform that uses AI to analyze student performance, generate personalized practice, and deliver an engaging, gamified learning experience. It serves four distinct roles โ€” Students, Teachers, Schools, and Admins โ€” through tailored dashboards, all under a single unified learning hierarchy.

The platform connects to a FastAPI backend (for users, questions, and analytics) and uses Google Genkit AI flows for adaptive practice, note generation, and weakness analysis.


โœจ Key Features

Feature Description
๐Ÿค– AI Adaptive Exam Engine Analyzes performance to generate personalized practice and real-time readiness scoring.
๐ŸŽฏ Unified Learning Tracks Classes 1โ€“12, Admission Tests, Global Exams, Government Jobs, and Skill Development in one hierarchy.
๐Ÿ“ Hybrid Examination Hub Timed MCQ exams with instant feedback and rich-text written-exam submissions.
โš”๏ธ Battleground Competitive, gamified exam arena with stats, leaderboards, and per-school showdowns.
๐Ÿ† Public Leaderboard Real-time student rankings to drive motivation and friendly competition.
๐Ÿ’ฌ Community Chat Moderated peer chat with bad-word filtering and time-boxed sessions.
๐Ÿ—’๏ธ AI Note Generator Generates structured study notes and a personal "weakness notebook" from past mistakes.
๐Ÿงฎ Math & Science Ready Full LaTeX / KaTeX rendering and MathLive input for STEM subjects.
๐ŸŒ Bilingual Locale Switcher Seamless real-time switching between English and Bangla across the whole app.
๐Ÿ” Tri-Role + School Portals Secure, role-based dashboards for Students, Teachers, Schools, and Admins.

๐Ÿ–ผ๏ธ Screenshots

Add the screenshots below into a docs/screenshots/ folder and keep the file names as listed so the links resolve automatically.

๐Ÿ”‘ Authentication

Login Register
Login Register

๐ŸŽ“ Student Dashboard

Student Dashboard Student Scheduled Exam

๐Ÿ‘จโ€๐Ÿซ Teacher Dashboard

Teacher Dashboard

๐Ÿซ School Dashboards

School Dashboard Battle Ground
School Battle Ground Creation

๐Ÿ›ก๏ธ Admin Dashboards

Admin Dashboard

๐Ÿ“ Examination Hub

Live Exam (MCQ + Timer) Results & Feedback
Exam Hub Exam Results

โš”๏ธ Battleground

Battleground

๐Ÿ† Leaderboard & ๐Ÿ’ฌ Community

Leaderboard Community Chat
Leaderboard Community

๐Ÿ—’๏ธ AI Note Generator & ๐Ÿค– Chatbot

Note Generator AI Chatbot
Note Generator Chatbot

๐ŸŒ Bilingual Mode (Bangla)

Bangla Interface


๐Ÿ› ๏ธ Tech Stack

Framework & Language

Styling & UI

AI & Content

Backend & Data


๐Ÿš€ Getting Started

Prerequisites

  • Node.js 18+ and npm
  • A Firebase project (for authentication)
  • The FastAPI backend running (default: http://localhost:8000)

1. Clone & Install

git clone <your-repo-url>
cd EduOrbit_Hack
npm install

2. Configure Environment

Copy the example env file and fill in your values:

cp .env.local.example .env.local
# Backend API
NEXT_PUBLIC_API_URL=http://localhost:8000

# Firebase
NEXT_PUBLIC_FIREBASE_API_KEY=your_firebase_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

3. Run the Dev Server

npm run dev

The app runs at http://localhost:9002.

4. (Optional) Run Genkit AI Flows Locally

npm run genkit:dev      # start Genkit dev UI
npm run genkit:watch    # with hot reload

๐Ÿ“œ Available Scripts

Script Description
npm run dev Start the Next.js dev server (Turbopack) on port 9002.
npm run build Create a production build.
npm run start Start the production server.
npm run lint Run ESLint.
npm run typecheck Run TypeScript type checking (tsc --noEmit).
npm run genkit:dev Launch the Genkit AI development environment.
npm run genkit:watch Launch Genkit AI with hot reload.

๐Ÿ“ Project Structure

EduOrbit_Hack/
โ”œโ”€โ”€ docs/
โ”‚   โ”œโ”€โ”€ blueprint.md            # Product blueprint & style guidelines
โ”‚   โ””โ”€โ”€ screenshots/            # ๐Ÿ“ธ Add your screenshots here
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ ai/                     # Genkit AI flows
โ”‚   โ”‚   โ””โ”€โ”€ flows/              # adaptive-practice, note-generator, weakness-notebook
โ”‚   โ”œโ”€โ”€ app/                    # Next.js App Router pages
โ”‚   โ”‚   โ”œโ”€โ”€ academic/           # Class 1โ€“12 track
โ”‚   โ”‚   โ”œโ”€โ”€ admission/          # Admission tests
โ”‚   โ”‚   โ”œโ”€โ”€ gov-jobs/           # Government job prep
โ”‚   โ”‚   โ”œโ”€โ”€ skills/             # Skill development
โ”‚   โ”‚   โ”œโ”€โ”€ exam-hub/           # Hybrid examination engine
โ”‚   โ”‚   โ”œโ”€โ”€ battleground/       # Gamified exam arena
โ”‚   โ”‚   โ”œโ”€โ”€ community/          # Moderated community chat
โ”‚   โ”‚   โ”œโ”€โ”€ leaderboard/        # Public rankings
โ”‚   โ”‚   โ”œโ”€โ”€ note-generator/     # AI note generation
โ”‚   โ”‚   โ”œโ”€โ”€ dashboard/          # student | teacher | school | admin
โ”‚   โ”‚   โ”œโ”€โ”€ login/ ยท register/  # Authentication
โ”‚   โ”‚   โ””โ”€โ”€ page.tsx            # Landing page
โ”‚   โ”œโ”€โ”€ components/             # UI, layout, auth, chatbot, editor, voice, home
โ”‚   โ”œโ”€โ”€ context/                # Global app context (language, etc.)
โ”‚   โ”œโ”€โ”€ firebase/               # Firebase config, providers & auth hooks
โ”‚   โ”œโ”€โ”€ hooks/                  # Custom React hooks
โ”‚   โ”œโ”€โ”€ lib/                    # API clients, books/chapter data, translations, utils
โ”‚   โ””โ”€โ”€ types/                  # Shared TypeScript types
โ”œโ”€โ”€ next.config.ts
โ”œโ”€โ”€ tailwind.config.ts
โ””โ”€โ”€ package.json

๐ŸŒ Localization

EduOrbit AI ships fully bilingual. All UI strings live in src/lib/translations.ts, and the active language is managed via the global app context โ€” switchable in real time from the navbar.


๐Ÿค Contributing

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Commit your changes: git commit -m "Add amazing feature"
  4. Push to the branch: git push origin feature/amazing-feature
  5. Open a Pull Request

Built with โค๏ธ for learners everywhere.

โญ Star this repo if you find it useful!

Releases

No releases published

Packages

 
 
 

Contributors

Languages