Skip to content

README.md

Latest commit

 

History

History
437 lines (321 loc) · 5.61 KB

README.md

File metadata and controls

437 lines (321 loc) · 5.61 KB
Raw

🚀 MaintainIQ

AI-Powered QR Maintenance & Asset Management Platform

Scan • Report • Diagnose • Maintain

A modern enterprise SaaS application that gives every physical asset a digital identity through QR codes, allowing organizations to manage maintenance workflows, issue tracking, technician assignments, and complete service history.

React TypeScript TailwindCSS Vite Shadcn UI GSAP Framer Motion LocalStorage

📌 Overview

MaintainIQ is an AI-powered maintenance management platform designed for:

  • 🏫 Schools
  • 🏢 Offices
  • 🏭 Factories
  • 🏥 Hospitals
  • 🏨 Hotels
  • 🧪 Laboratories
  • 🏘 Housing Societies
  • 🏬 Warehouses

Instead of managing maintenance through WhatsApp messages, Excel sheets, or registers, MaintainIQ centralizes the complete lifecycle of every asset.

✨ Features

🔐 Authentication

  • Public User Sign Up
  • Public User Login
  • Continue with Google (UI Ready)
  • Admin Login
  • Worker Login
  • Forgot Password
  • Remember Me
  • Protected Routes
  • Role-Based Access

👥 User Roles

👑 Super Admin

  • Dashboard
  • Asset Management
  • QR Code Generation
  • Worker Management
  • Issue Assignment
  • Analytics
  • Reports
  • Notifications
  • Settings
  • Activity Logs

👷 Worker

  • Login
  • Assigned Tasks
  • Maintenance Workflow
  • Inspection
  • Upload Evidence
  • Resolve Issues
  • History
  • Profile

🌍 Public User

  • Scan QR
  • View Asset
  • Report Issue
  • Track Issue Status

🏢 Asset Management

  • Create Asset
  • Edit Asset
  • Delete Asset
  • Asset Details
  • QR Generation
  • Download QR
  • Print QR
  • Asset Health
  • Maintenance Schedule
  • Timeline
  • History

🛠 Maintenance Workflow

Asset Created
      ↓
QR Generated
      ↓
User Reports Issue
      ↓
Admin Reviews
      ↓
Worker Assigned
      ↓
Inspection
      ↓
Maintenance
      ↓
Issue Resolved
      ↓
History Updated
      ↓
Analytics Updated

🤖 AI Features (UI Ready)

  • AI Issue Triage
  • AI Maintenance Summary
  • AI Preventive Suggestions
  • AI Asset Health Score
  • AI Similar Issues
  • AI Reports

📊 Dashboard

Admin Dashboard

  • Statistics
  • Asset Health
  • Maintenance Calendar
  • Open Issues
  • Critical Issues
  • Worker Performance
  • Notifications
  • Activity Timeline
  • Charts
  • Quick Actions

Worker Dashboard

  • Today's Tasks
  • Assigned Issues
  • Completed Jobs
  • Pending Work
  • Maintenance History
  • Performance Overview

📱 Pages

Public

  • Home
  • Features
  • About
  • Contact
  • Login
  • Signup
  • Forgot Password
  • QR Asset Page
  • Track Issue

Admin

  • Dashboard
  • Assets
  • Asset Details
  • Workers
  • Issues
  • Analytics
  • Activity Logs
  • Notifications
  • Profile
  • Settings

Worker

  • Dashboard
  • Assigned Issues
  • Maintenance
  • History
  • Profile

🎨 UI & UX

Designed with modern SaaS principles inspired by:

  • Linear
  • Stripe
  • Notion
  • Apple
  • Framer
  • Vercel

Features include:

  • Glassmorphism
  • Responsive Layout
  • Dark / Light Mode
  • Smooth GSAP Animations
  • Premium Dashboard
  • Skeleton Loading
  • Empty States
  • Micro Interactions

⚡ Animations

  • GSAP Page Transitions
  • Animated Sidebar
  • Statistics Counter
  • QR Floating Animation
  • Scroll Reveal
  • Timeline Animation
  • Card Hover Effects
  • Modal Animations
  • Notification Animations
  • Loading Skeletons

🧱 Tech Stack

Frontend

  • React 19
  • TypeScript
  • Vite
  • TailwindCSS
  • Shadcn UI
  • React Router
  • React Hook Form
  • Zod
  • TanStack Query
  • GSAP
  • Framer Motion
  • Recharts
  • Lucide Icons
  • QRCode

Storage

Current Version

  • LocalStorage

Future Backend

  • Express.js
  • MongoDB
  • JWT
  • Cloudinary
  • Socket.IO
  • Redis

📁 Project Structure

src
│
├── assets
├── components
├── layouts
├── pages
├── features
├── services
├── storage
├── hooks
├── contexts
├── animations
├── routes
├── utils
├── constants
├── providers
├── types
└── App.tsx

💾 Local Storage Collections

users
workers
assets
issues
maintenance
history
notifications
settings
organization
sessions
auditLogs

🔐 Demo Credentials

Super Admin

Email:
admin@maintainiq.com

Password:
password123

Worker

Created by Super Admin.

Public User

Register from Signup page.

🚀 Installation

git clone https://github.com/yourusername/maintainiq.git

cd maintainiq

npm install

npm run dev

📦 Build

npm run build

🔮 Future Improvements

  • Express Backend
  • MongoDB
  • Google OAuth
  • AI Integration
  • Cloudinary Uploads
  • Socket.IO
  • Email Notifications
  • Redis
  • Docker
  • AWS Deployment

🎯 Hackathon Goals

  • Enterprise-Level UI
  • Real SaaS Experience
  • QR Asset Management
  • Issue Tracking
  • Maintenance Workflow
  • Role-Based Access
  • AI Ready Architecture

👨‍💻 Author

Zohaib

SMIT Final Hackathon Project

MaintainIQ - AI Powered QR Maintenance & Asset Management Platform

📜 License

MIT License

⭐ If you like this project, don't forget to star the repository.

Made with ❤️ using React, TypeScript & TailwindCSS