How fthabhishek-pandey/koshish-welfare-and-education-society works
Project type and purpose
• Koshish is a multi-tenant full-stack school management application. It consists of:
• Two React-based frontends:
– Adminpannel: for administrators, coordinators, and co-circulers (club leaders)
– Koshish: the public/student/teacher-facing site
• A Node.js/Express backend providing RESTful endpoints
• MongoDB as the primary data store
• Third-party Cloudinary for image uploads
• JWT authentication layers per user role
File structure
• Top-level:
• Adminpannel/ and Koshish/: separate React/Vite frontend codebases
• backend/: Express server, controllers, routes, models, middleware, config
• Frontends share a similar structure:
• src/components, src/pages, src/context, src/utilities (API calls)
• Vite config, public static assets, .env for API base URLs
• Backend:
• config/: MongoDB connection, Cloudinary setup
• middleware/: JWT auth per role, file-upload, error handling, logging
• controller/: business logic grouped by domain (app, cocirculer, coordinator, teacher, student)
• models/: Mongoose schemas grouped by domain
• routes/: maps URLs to controllers
• server.js: bootstraps Express, connects to DB, mounts routes
• uploads/: local file storage (fallback for images)
README for additional insights
• Four dashboards: Admin, Co-circuler, Teacher, Student (two in progress)
• Operations: user management, class & event management, announcements, submissions, metrics
• Tech stack callouts: React + Vite, Node/Express, MongoDB, JWT
Main components & their interactions
a. Components
• Frontend Tier
– Adminpannel App (React)
– Koshish Public App (React)
• API Tier
– Express.js server
– Route handlers (appRoutes, coCirculerRoutes, coordinatorRoutes, teacherRoutes, userRoutes)
• Persistence Tier
– MongoDB cluster
– Local uploads directory (for development)
– Cloudinary (for production uploads)
• Auth & Security
– JWT issuance and verification middleware per role
• External Systems
– Cloudinary CDN
– (Optional) Third-party analytics or logging
b. Relationships & Data Flow
1. User visits frontend (Adminpannel or Koshish)
2. Frontend fetches data via REST calls to Express server (e.g., GET /api/app/events)
3. Express middleware validates JWT, parses request, routes to controller
4. Controller calls repository or model to perform CRUD on MongoDB
5. For file uploads, middleware sends files to Cloudinary, returns URLs to controllers
6. Controller responds JSON to frontend
7. Frontend renders state, user interacts, cycle repeats
8. Logging middleware writes request logs; errorHandler catches exceptions
c. Architectural patterns & principles
• Layered architecture: Presentation (React), Application (Express controllers), Domain/Model (Mongoose), Infrastructure (MongoDB, Cloudinary)
• Separation of concerns: controllers vs. repositories vs. models
• Context providers (React Context) to manage global state (auth, user roles)
• Folder-by-domain grouping in backend for clarity
• JWT security per role to restrict endpoints
d. Key technologies & frameworks
• React + Vite + styled-components (frontends)
• React Context for state
• Axios or fetch wrappers in src/utilities/src/utils for API calls
• Express.js + Node.js
• Mongoose (MongoDB ODM)
• JWT (jsonwebtoken)
• Cloudinary SDK + multer for file uploads
• Winston or custom logger middleware
• Vercel or similar for frontend deployment, Heroku/Docker for backend