IIITM Insight

A comprehensive platform for IIITM students offering academic resources, marketplace, community features, collaboration tools, and more.

🎯 Overview

IIITM Insight is a full-stack web application designed to enhance the academic and campus life experience for IIITM students. The platform provides a centralized hub for sharing notes, buying/selling items, connecting with peers, and accessing essential student tools.

✨ Key Features

📚 Academic Resources

• Notes Library - Upload, download, and share class notes
• PYQ Bank - Access previous year question papers
• Books Repository - Digital library of textbooks and references
• Syllabus - Current syllabi for all courses

🛒 Marketplace

• Buy, sell, or rent items within campus
• Categories: Books, Electronics, Furniture, Stationery
• Secure transaction system with reviews
• Chat with sellers directly

👥 Community & Social

• Activity Feed - Campus-wide social feed
• Blogs - Write and share technical/experience blogs
• Events - Campus events calendar
• Lost & Found - Report and claim lost items

⭐ Reviews & Ratings

• Professor Reviews - Anonymous professor ratings
• Course Reviews - Student feedback on courses
• Detailed ratings on teaching quality, accessibility, grading

🤝 Collaboration

• Study Groups - Form and join study groups
• Project Partners - Find teammates for projects
• Skill Exchange - Teach and learn from peers
• Real-time chat within groups

🛠️ Student Tools

• CGPA Calculator - Track and calculate grades
• Attendance Tracker - Monitor attendance with alerts
• Timetable Manager - Organize class schedules

🎓 Opportunities

• Internships, workshops, competitions
• Scholarship information
• Career opportunities

🔍 Search & Discovery

• Full-text search across all content
• Advanced filtering and sorting
• Trending content suggestions

🔔 Notifications

• Real-time notifications
• Email digests
• Customizable preferences

👨‍💼 Admin Panel

• User management
• Content moderation
• Analytics dashboard
• System configuration

🏗️ Architecture

Technology Stack

Frontend:

• React 18 with Hooks
• Tailwind CSS for styling
• React Router for navigation
• Axios for API calls
• Socket.io-client for real-time features
• Redux/Zustand for state management

Backend:

• Node.js with Express.js
• PostgreSQL for relational data
• MongoDB for activity feeds and logs
• Redis for caching and sessions
• Elasticsearch for search
• Bull Queue for background jobs
• Socket.io for real-time communication

Storage:

• AWS S3 / GCP Cloud Storage for files
• Local storage for development

Deployment:

• Docker & Docker Compose
• Nginx reverse proxy
• AWS/GCP cloud infrastructure

📦 Project Structure

iiitm-insight/
├── client/                 # React frontend
│   ├── src/
│   │   ├── components/    # Reusable components
│   │   ├── pages/         # Page components
│   │   ├── services/      # API services
│   │   ├── hooks/         # Custom hooks
│   │   ├── context/       # React context
│   │   ├── utils/         # Utilities
│   │   └── App.jsx
│   └── package.json
│
├── server/                 # Node.js backend
│   ├── src/
│   │   ├── config/        # Configuration
│   │   ├── models/        # Database models
│   │   ├── controllers/   # Request handlers
│   │   ├── services/      # Business logic
│   │   ├── middleware/    # Express middleware
│   │   ├── routes/        # API routes
│   │   ├── utils/         # Utilities
│   │   └── server.js
│   └── package.json
│
├── docker/                 # Docker configuration
│   ├── docker-compose.yml
│   ├── Dockerfile.client
│   └── Dockerfile.server
│
├── docs/                   # Documentation
│   ├── API.md
│   ├── ARCHITECTURE.md
│   └── DEPLOYMENT.md
│
└── README.md

🚀 Getting Started

Prerequisites

• Node.js >= 18.0.0
• PostgreSQL >= 15
• MongoDB >= 6
• Redis >= 7
• Docker (optional, for containerized setup)

Installation

Option 1: Local Development

1. Clone the repository:

git clone https://github.com/your-org/iiitm-insight.git
cd iiitm-insight

2. Setup Backend:

cd server
npm install
cp .env.example .env
# Edit .env with your configuration
npm run dev

3. Setup Frontend:

cd client
npm install
cp .env.example .env
# Edit .env with your configuration
npm start

Option 2: Docker Setup

cd iiitm-insight
docker-compose up -d

Access the Application

• Frontend: http://localhost:3000
• Backend API: http://localhost:5000
• API Docs: http://localhost:5000/api/docs

Default Admin Credentials

Email: [email protected]
Password: Admin@123 (Change after first login!)

📖 Documentation

• API Documentation
• Architecture Guide
• Deployment Guide
• Contributing Guide
• User Guide

🧪 Testing

Backend:

cd server
npm test

Frontend:

cd client
npm test

🔧 Development

Code Style

• ESLint for linting
• Prettier for formatting
• Conventional commits

Git Workflow

1. Create feature branch from develop
2. Make changes and commit
3. Push and create pull request
4. Code review and merge

🚢 Deployment

Production Deployment

See Deployment Guide for detailed instructions.

Quick Deploy:

docker-compose -f docker-compose.prod.yml up -d

🔒 Security

• JWT-based authentication
• Role-based access control
• Rate limiting
• Input validation and sanitization
• SQL injection prevention
• XSS protection
• HTTPS enforcement in production

📊 Performance

• Redis caching
• Database indexing
• Image optimization
• Code splitting
• Lazy loading
• CDN for static assets

🤝 Contributing

We welcome contributions! Please see our Contributing Guide.

1. Fork the repository
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Open a pull request

📝 License

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

👥 Team

IIITM Insight Development Team

• Project Lead: [Name]
• Backend Lead: [Name]
• Frontend Lead: [Name]
• UI/UX Designer: [Name]

📧 Contact

• Email: [email protected]
• Website: https://iiitm-insight.com
• GitHub: https://github.com/your-org/iiitm-insight

🙏 Acknowledgments

• IIITM Faculty and Administration
• All contributors and testers
• Open source community

📈 Roadmap

• Mobile app (React Native)
• AI-powered content recommendations
• Video lectures integration
• Discussion forums
• Alumni network
• Job portal integration
• Advanced analytics dashboard
• Multi-language support

---

Made with ❤️ by IIITM Students, for IIITM Students