🚂 RailSuraksha - AI-Powered Railway Analytics Platform

Advanced Railway Track Fitting Management with AI-Driven Analytics

🚀 Live Demo • 🐛 Report Bug • ✨ Request Feature

📋 Table of Contents

🎯 Overview
✨ Features
🏗️ Architecture
🚀 Quick Start
📱 Screenshots
🛠️ Tech Stack
📦 Installation
⚙️ Configuration
🔧 Usage
📊 API Reference
🧪 Testing
🚀 Deployment
🤝 Contributing
📄 License

🎯 Overview

RailSuraksha is a comprehensive, AI-powered railway analytics platform designed to revolutionize track fitting management and maintenance operations. Built for Indian Railways and modern transit systems, it provides real-time monitoring, predictive analytics, and intelligent inventory management for railway infrastructure components.

🌟 Key Highlights

🔍 Real-time Monitoring: Live tracking of railway track fittings across all zones
🤖 AI-Powered Analytics: Predictive maintenance and risk assessment algorithms
📊 Comprehensive Dashboard: Interactive visualizations with advanced filtering
🏷️ QR Code Management: Generate and track QR codes for physical assets
📦 Smart Inventory: Complete CRUD operations with warranty tracking
🔗 System Integration: Seamless connectivity with existing railway systems
📱 Responsive Design: Optimized for desktop, tablet, and mobile devices
🌙 Dark Mode: Professional dark theme for extended usage

✨ Features

🎛️ Dashboard & Analytics

Interactive Metrics: Real-time KPIs with trend analysis
Risk Assessment: Zone-wise risk mapping with severity indicators
Vendor Performance: Quality scoring and performance tracking
Predictive Maintenance: AI-driven maintenance scheduling
Custom Reports: Export analytics in multiple formats (CSV, Excel, JSON, PDF)

📦 Inventory Management

Asset Tracking: Complete lifecycle management of railway components
CRUD Operations: Add, edit, delete inventory items with validation
Advanced Filtering: Multi-parameter search and filtering system
Warranty Management: Automated warranty tracking and notifications
Batch Processing: Bulk operations and data export capabilities

🏷️ QR Code Generation

Dynamic QR Codes: Generate QR codes for physical asset tracking
Batch Creation: Bulk QR code generation for multiple items
Multiple Formats: Export as PNG, SVG, and PDF formats
Custom Styling: Configurable QR code appearance and branding

🔗 System Integration

API Connectivity: RESTful APIs for external system integration
Real-time Sync: Live data synchronization with railway databases
Health Monitoring: System status dashboard with uptime tracking
Error Handling: Comprehensive logging and error recovery

🔔 Notifications & Alerts

Smart Alerts: Priority-based notification system
Risk Warnings: Automated alerts for high-risk components
Maintenance Reminders: Scheduled maintenance notifications
System Updates: Real-time status updates and announcements

🏗️ Architecture

Frontend Architecture

├── 🎨 Presentation Layer (React + Next.js)
│   ├── Components (Modular UI Components)
│   ├── Pages (Route-based Navigation)
│   └── Hooks (Custom React Hooks)
├── 🔄 State Management (React State + Context)
├── 🎯 Business Logic Layer
├── 📡 API Integration Layer
└── 🎨 Styling (Tailwind CSS + shadcn/ui)

Component Structure

components/
├── 📊 dashboard/          # Analytics and metrics
├── 📦 inventory/          # Asset management
├── 🏷️ qr-generation/     # QR code utilities
├── 🔗 integration/       # System connectivity
├── 🔔 notifications/     # Alert system
├── 🚨 alerts/            # Priority notifications
├── 🎨 ui/                # Reusable UI components
└── 📱 analytics/         # Advanced analytics

🚀 Quick Start

Prerequisites

Node.js 18.0+
pnpm 8.0+ (recommended) or npm
Git for version control

1️⃣ Clone Repository

git clone https://github.com/YashhhCodesHere/rail-suraksha.git
cd rail-suraksha

2️⃣ Install Dependencies

pnpm install

3️⃣ Start Development Server

pnpm dev

4️⃣ Open Application

Visit http://localhost:3000 in your browser.

📱 Screenshots

🎯 Dashboard Overview

📦 Inventory Management

🏷️ QR Code Generation

🔗 System Integration

🛠️ Tech Stack

Frontend Technologies

Technology	Version	Purpose
⚛️ React	19.0	UI Library
🔗 Next.js	14.2.25	React Framework
📘 TypeScript	5.0	Type Safety
🎨 Tailwind CSS	4.1.9	Styling Framework
🧩 shadcn/ui	Latest	Component Library
📊 Recharts	2.15.4	Data Visualization

UI Components & Libraries

Library	Purpose
🎛️ Radix UI	Headless UI Components
📅 date-fns	Date Manipulation
🏷️ qrcode	QR Code Generation
🎭 Lucide React	Icon Library
🎨 class-variance-authority	Component Variants
📊 Recharts	Charts & Graphs

Development Tools

Tool	Purpose
📦 pnpm	Package Manager
🔍 ESLint	Code Linting
🎯 TypeScript	Static Type Checking
🎨 PostCSS	CSS Processing
⚡ Vercel Analytics	Performance Monitoring

📦 Installation

Development Setup

Clone and Navigate

git clone https://github.com/YashhhCodesHere/rail-suraksha.git
cd rail-suraksha

Install Dependencies

# Using pnpm (recommended)
pnpm install

# Or using npm
npm install

# Or using yarn
yarn install

Environment Setup

cp .env.example .env.local
# Edit .env.local with your configuration

Start Development
```
pnpm dev
```

Production Build

# Build for production
pnpm build

# Start production server
pnpm start

# Export static files
pnpm export

⚙️ Configuration

Environment Variables

Create a .env.local file in the root directory:

# Application
NEXT_PUBLIC_APP_URL=http://localhost:3000
NEXT_PUBLIC_APP_NAME=RailSuraksha

# API Configuration
NEXT_PUBLIC_API_BASE_URL=https://api.railsuraksha.com
API_SECRET_KEY=your_secret_key_here

# Database (if applicable)
DATABASE_URL=postgresql://username:password@localhost:5432/railsuraksha

# Analytics
VERCEL_ANALYTICS_ID=your_analytics_id

# Feature Flags
NEXT_PUBLIC_ENABLE_ANALYTICS=true
NEXT_PUBLIC_ENABLE_NOTIFICATIONS=true

Next.js Configuration

The application uses the following Next.js configuration (next.config.mjs):

const nextConfig = {
  output: 'export',           // Static site generation
  eslint: {
    ignoreDuringBuilds: true, // Skip ESLint during builds
  },
  typescript: {
    ignoreBuildErrors: true,  // Skip TypeScript errors during builds
  },
  images: {
    unoptimized: true,        // Disable image optimization for static export
  },
}

🔧 Usage

Dashboard Navigation

Dashboard: View analytics and key metrics
QR Generation: Create QR codes for assets
Inventory: Manage railway components
Analytics: Advanced reporting and insights
Integration: System health and connectivity

Inventory Management

// Add new inventory item
const newItem = {
  batchId: "24-01-1234",
  vendor: "Tata Steel Limited",
  itemType: "Rail Joint",
  zone: "Northern Railway",
  location: "Section A, Track 1",
  // ... other properties
};

QR Code Generation

// Generate QR code
const qrData = {
  batchId: "24-01-1234",
  type: "Rail Joint",
  location: "Track Section A",
};

const qrCode = await generateQRCode(qrData);

Export Data

// Export inventory as CSV
handleExport('csv');

// Export as Excel
handleExport('excel');

// Export as JSON with metadata
handleExport('json');

// Print report
handleExport('print');

📊 API Reference

Inventory Endpoints

GET    /api/inventory           # Get all inventory items
POST   /api/inventory           # Create new item
PUT    /api/inventory/:id       # Update item
DELETE /api/inventory/:id       # Delete item

Analytics Endpoints

GET    /api/analytics/dashboard # Dashboard metrics
GET    /api/analytics/trends    # Trend data
GET    /api/analytics/zones     # Zone-wise analysis

QR Code Endpoints

POST   /api/qr/generate         # Generate QR code
GET    /api/qr/:id              # Get QR code data

Integration Endpoints

GET    /api/integration/status  # System health
POST   /api/integration/sync    # Sync data
GET    /api/integration/logs    # System logs

🧪 Testing

Run Tests

# Run all tests
pnpm test

# Run tests in watch mode
pnpm test:watch

# Run tests with coverage
pnpm test:coverage

Test Structure

tests/
├── __tests__/
│   ├── components/     # Component tests
│   ├── pages/         # Page tests
│   └── utils/         # Utility tests
├── __mocks__/         # Mock data
└── setup.ts           # Test setup

🚀 Deployment

Vercel Deployment (Recommended)

Connect Repository
```
npx vercel
```
Configure Environment
- Add environment variables in Vercel dashboard
- Set build command: pnpm build
- Set output directory: out
Deploy
```
npx vercel --prod
```

Static Export

# Generate static files
pnpm export

# Deploy to any static hosting
# Files will be in the 'out' directory

Docker Deployment

FROM node:18-alpine
WORKDIR /app
COPY package*.json ./
RUN npm install
COPY . .
RUN npm run build
EXPOSE 3000
CMD ["npm", "start"]

🤝 Contributing

We welcome contributions! Please follow our guidelines:

Development Workflow

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Code Standards

Use TypeScript for type safety
Follow ESLint rules
Write meaningful commit messages
Add tests for new features
Update documentation as needed

Pull Request Process

Ensure your code builds successfully
Update README.md with new features
Add tests for your changes
Request review from maintainers

📈 Roadmap

Q1 2025

🔐 Authentication System - User management and role-based access
📱 Mobile App - React Native companion app
🤖 Advanced AI - Machine learning models for predictive analytics

Q2 2025

🌐 Multi-language Support - Internationalization (i18n)
📊 Advanced Reporting - Custom report builder
🔗 API Gateway - Standardized API management

Q3 2025

🛰️ IoT Integration - Sensor data integration
📡 Real-time Updates - WebSocket implementation
🔒 Enhanced Security - Advanced security features

📞 Support

Get Help

📖 Documentation: Check our comprehensive docs
🐛 Bug Reports: Create an issue
💡 Feature Requests: Request a feature
💬 Discussions: Join discussions

Contact

🧑‍💻 Developer: YashhhCodesHere
📧 Email: support@railsuraksha.com
🌐 Website: railsuraksha.com

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

MIT License

Copyright (c) 2025 RailSuraksha

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

🙏 Acknowledgments

Built With

⚛️ React Team - For the amazing React framework
🔗 Vercel - For Next.js and hosting platform
🎨 Tailwind Labs - For the utility-first CSS framework
🧩 shadcn - For the beautiful component library
📊 Recharts Team - For the visualization library

Special Thanks

🚂 Indian Railways - For inspiration and domain knowledge
👥 Open Source Community - For countless contributions
🧑‍💻 Contributors - For making this project better

⭐ Star this repo if you find it helpful!

Made with ❤️ for the Railway Industry

🚀 Live Demo • 📚 Documentation • 🤝 Contribute

Name		Name	Last commit message	Last commit date
Latest commit History 4 Commits
app		app
components		components
hooks		hooks
lib		lib
out		out
public		public
styles		styles
.gitignore		.gitignore
README.md		README.md
components.json		components.json
next-env.d.ts		next-env.d.ts
next.config.mjs		next.config.mjs
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
postcss.config.mjs		postcss.config.mjs
tsconfig.json		tsconfig.json

BeLike-Harsh/rail-suraksha

Folders and files

Latest commit

History

Repository files navigation

🚂 RailSuraksha - AI-Powered Railway Analytics Platform

📋 Table of Contents

🎯 Overview

🌟 Key Highlights

✨ Features

🎛️ Dashboard & Analytics

📦 Inventory Management

🏷️ QR Code Generation

🔗 System Integration

🔔 Notifications & Alerts

🏗️ Architecture

Frontend Architecture

Component Structure

🚀 Quick Start

Prerequisites

1️⃣ Clone Repository

2️⃣ Install Dependencies

3️⃣ Start Development Server

4️⃣ Open Application

📱 Screenshots

🎯 Dashboard Overview

📦 Inventory Management

🏷️ QR Code Generation

🔗 System Integration

🛠️ Tech Stack

Frontend Technologies

UI Components & Libraries

Development Tools

📦 Installation

Development Setup

Production Build

⚙️ Configuration

Environment Variables

Next.js Configuration

🔧 Usage

Dashboard Navigation

Inventory Management

QR Code Generation

Export Data

📊 API Reference

Inventory Endpoints

Analytics Endpoints

QR Code Endpoints

Integration Endpoints

🧪 Testing

Run Tests

Test Structure

🚀 Deployment

Vercel Deployment (Recommended)

Static Export

Docker Deployment

🤝 Contributing

Development Workflow

Code Standards

Pull Request Process

📈 Roadmap

Q1 2025

Q2 2025

Q3 2025

📞 Support

Get Help

Contact

📄 License

🙏 Acknowledgments

Built With

Special Thanks

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages