Skip to content

VARA4u-tech/EduPredict

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

35 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŽ“ EduPredict - Predictive Analytics System for Student Performance Forecasting Platform

image

AI-Powered Student Success Prediction Dashboard

React Node.js Express OpenAI TypeScript Tailwind CSS Vite


๐Ÿ“– About

EduPredict is an innovative AI-powered student success prediction platform with a fun comic book-inspired UI. It helps educators and institutions identify at-risk students early and take proactive measures to improve academic outcomes.


โœจ Key Features

  • ๐ŸŽฏ Predictive Analytics - AI-powered grade predictions based on attendance, assignments, and more
  • ๐Ÿ“Š Interactive Dashboards - Role-based dashboards for Students, Faculty, and Administrators
  • ๐ŸŽฎ Gamification - XP system, levels, and achievements to motivate students
  • ๐Ÿ“– Comic Strip Stories - Engaging visual narratives that explain academic journeys
  • ๐ŸŒ™ Theme Modes - Light, Dark, and unique "Inked" comic book mode
  • ๐Ÿ”” Real-time Alerts - Smart notifications for at-risk students
  • ๐Ÿ“„ Report Generation - Downloadable performance reports
  • ๐ŸŽจ Comic Book Design - Fun, engaging UI with sticker badges, speech bubbles, and animations

๐Ÿ› ๏ธ Tech Stack

Technology Purpose
React 18 UI Framework
TypeScript Type Safety
Vite Build Tool & Dev Server
Tailwind CSS Styling
Framer Motion Animations
shadcn/ui UI Components
React Router Navigation
Recharts Data Visualization
Lucide Icons Iconography
Zod Form Validation

๐Ÿš€ Getting Started

Prerequisites

Installation

# Clone the repository
git clone https://github.com/VARA4u-tech/student-success-comic.git

# Navigate to the project directory
cd student-success-comic

# Install dependencies
npm install

# Start the development server
npm run dev

The application will open at http://localhost:5173


๐Ÿ“ Project Structure

src/
โ”œโ”€โ”€ assets/          # Images and static assets
โ”œโ”€โ”€ components/      # Reusable UI components
โ”‚   โ”œโ”€โ”€ ui/          # shadcn/ui components
โ”‚   โ”œโ”€โ”€ ComicButton.tsx
โ”‚   โ”œโ”€โ”€ ComicCard.tsx
โ”‚   โ”œโ”€โ”€ ComicStrip.tsx
โ”‚   โ”œโ”€โ”€ Navbar.tsx
โ”‚   โ”œโ”€โ”€ Footer.tsx
โ”‚   โ””โ”€โ”€ ...
โ”œโ”€โ”€ context/         # React Context providers
โ”œโ”€โ”€ hooks/           # Custom React hooks
โ”œโ”€โ”€ lib/             # Utility functions
โ”œโ”€โ”€ pages/           # Page components
โ”‚   โ”œโ”€โ”€ LandingPage.tsx
โ”‚   โ”œโ”€โ”€ StudentDashboard.tsx
โ”‚   โ”œโ”€โ”€ FacultyDashboard.tsx
โ”‚   โ”œโ”€โ”€ AdminDashboard.tsx
โ”‚   โ””โ”€โ”€ ...
โ”œโ”€โ”€ App.tsx          # Main app with routing
โ”œโ”€โ”€ index.css        # Global styles & design system
โ””โ”€โ”€ main.tsx         # Entry point

๐ŸŽจ Design System

EduPredict uses a unique comic book-inspired design system with:

  • Bold borders and comic-style shadows
  • Vibrant color palette (Yellow, Red, Green, Blue accents)
  • Custom fonts (Bangers for headings, Comic Neue for body text)
  • Sticker badges and animated elements
  • Halftone patterns and action backgrounds

๐Ÿ“ฑ Pages & Features

Public Pages

  • Landing Page - Hero section, features, testimonials
  • About Page - Mission and values
  • Help/FAQ Page - Common questions and support
  • Contact Page - Contact form and information

Dashboard Pages

  • Student Dashboard - Personal performance, predictions, recommendations
  • Faculty Dashboard - Class overview, student tracking
  • Admin Dashboard - Institution-wide analytics, alerts
  • Prediction Page - Interactive "What If" scenario analysis
  • Reports Page - Downloadable analytics and charts

๐Ÿ”ง Available Scripts

Script Description
npm run dev Start development server
npm run build Build for production
npm run preview Preview production build
npm run lint Run ESLint

๐Ÿค Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

๐Ÿ“„ License

This project is licensed under the MIT License.


๐Ÿ‘จโ€๐Ÿ’ป Author

VARA4u-tech



Engineered & Deigned With ๐Ÿ’ก By VARA for Education

๐ŸŽ“ Empowering Students, One Prediction at a Time! ๐Ÿš€

About

๐Ÿ“š"EduPredict is an innovative AI-powered student success prediction platform with a fun comic book-inspired UI. It helps educators and institutions identify at-risk students early and take proactive measures to improve academic outcomes".

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Contributors