How akrathor18/note-sharing-app works
Project Type and Purpose
• StudyHub is a full-stack web application (MERN: MongoDB, Express, React, Node.js).
• Purpose: allow users to sign up/in, upload and browse study notes, and take MCQ quizzes.
File Structure
A. Top-level:
• backend/
• client/
B. Backend directories:
• config/ (db connection, Cloudinary setup)
• middleware/ (JWT auth, file upload)
• model/ (Mongoose schemas: User, Note, Quiz)
• routers/ (Express routes for users, notes, quizzes)
• index.js (Express app entrypoint)
C. Client directories:
• src/ (React components, auth utilities, axios config)
• Tailwind/Vite configuration files
README
• Confirms MERN stack, user-generated content (notes) + quizzes, interactive UX.
Main Components and Their Interactions
A. Frontend (React SPA)
• Browser runs React app (components: SignIn, SignUp, Dashboard, Notes, Quiz, etc.)
• Uses ProtectedRoute for client-side route guarding
• axios.js handles HTTP requests to backend API
B. Backend (Node.js + Express)
• index.js configures Express server, mounts routers
• Routers call Mongoose models for CRUD operations
• Middleware:
• authMiddleware + verifyJWT for protected endpoints
• upload (Cloudinary) for note image/files
C. Database (MongoDB)
• Stores Users, Notes, Quizzes
D. External Service (Cloudinary)
• Stores uploaded images/files for notes
Flow:
Browser → HTTP(S) → Express API → Middleware → Mongoose → MongoDB
↘ Cloudinary (for file uploads)
Architectural Patterns & Design Principles
• Layered architecture:
1. Presentation (React)
2. API layer (Express routers + middleware)
3. Data layer (Mongoose + MongoDB)
• Stateless JWT authentication
• Single-page application on client side
• Separation of concerns: each folder has a single responsibility (config, middleware, models, routers)
Putting It All Together
• Routers (Users, Notes, Quizzes)
• Middleware (auth, upload)
• Config (db.js, cloudinary.js)