How vimalnegi03/tutor_finder works
Project Type & Purpose
– This is a full-stack MERN application (“Tutor Finder”) that connects students and tutors.
– Frontend: React + Redux + Tailwind for UI and state management.
– Backend: Node.js/Express REST API + Socket.IO for real-time chat.
– Database: MongoDB with Mongoose ODM.
– File storage: Multer + local storage + Cloudinary.
Main Components
a. Frontend (Client)
• React application (src/)
• UI components (Auth, Chat, Home, Notes, TutorsList, Groups, TutorDashboard)
• Redux store & slices for auth, chat, groups, messages, reviews, tutors
• Socket.IO client (socket.js) for real-time messaging
• Static assets (public/pdfs, audio)
b. Backend (Server)
• Express server (server.js)
• Routes: authRoutes, userRoutes, chatRoutes, groupRoutes, messageRoutes, reviewRoutes, emailRoutes
• Controllers: userController, groupController, messageController, reviewController
• Middleware: authMiddleware (JWT), upload (Multer)
• Models: User, Group, Message, Chat (room schema)
• Services: emailService (SMTP), Cloudinary integration (cloudinaryConfig.js)
• Socket.IO server (in server.js + firebase-admin for notifications)
• Static/public uploads directory
c. Database
• MongoDB collections corresponding to models
d. External Services
• Cloudinary for media storage
• Email service provider (via emailService.js)
• Optional Push notifications via Firebase Admin
Component Interactions & Data Flows
– User/browser → HTTP(S) requests → Express routes → Controllers → Mongoose → MongoDB
– After login/signup, frontend stores JWT → attaches to Authorization header → protected routes check authMiddleware
– Real-time chat: React components emit/receive events through Socket.IO client ↔ Socket.IO server
– File upload in chat: ReactForm → POST multipart via Multer middleware → files stored temporarily or uploaded to Cloudinary → URL returned to client → chat message saved
– Reviews & ratings: frontend dispatches Redux actions → API calls → reviewController persists to DB → updated stats fetched and displayed in dashboards
– Email notifications: certain events trigger emailService (e.g., group requests)
Architectural Patterns & Design Principles
– MVC-style layering in backend: Routes → Controllers → Models → Services
– Single-Page Application (SPA) on frontend organized by feature modules (Auth, Chat, Notes, Groups)
– State management via Redux Toolkit slices (separation of concerns, immutability)
– Real-time communications abstracted into a socket module both client/server sides
– File handling separated via dedicated middleware and external service (Cloudinary)
Technologies & Frameworks to Highlight
– React.js + Redux Toolkit + Tailwind CSS
– Vite as bundler for client (vite.config.js)
– Node.js + Express.js for REST API
– Socket.IO for real-time bidirectional events
– MongoDB + Mongoose for data persistence
– JWT + bcrypt for authentication/security
– Multer for multipart/form-data handling
– Cloudinary SDK for media uploads
– Firebase Admin for notifications (serviceAccountKey.json)