How atharvaj1425/aissms-pune-hack works
Project type and purpose
• This is a full‑stack web application called “Surplus Food Redistribution Platform.”
• It connects surplus‑food donors (restaurants, caterers, bakeries) with recipients (NGOs, shelters, volunteers), using AI for predictions and a chat‑bot, plus real‑time routing and SMS notifications.
File structure
• Top‑level directories:
• Backend: Node.js/Express API with MVC structure (controllers, models, routes, middlewares, utils).
• Frontend: React.js application built with Vite/Webpack, component folders organized by user role (Consumer, NGO, Restaurant, Volunteer, Recipe, Chat‑bot).
• flask: Python/Flask microservice hosting AI/ML models (.pkl) for predictive analytics.
• docker-compose.yml & individual Dockerfiles: container orchestration for backend, frontend, MongoDB.
• config files: package.json, .env, azure-pipelines.yaml for CI/CD.
Extract architecture insights from README
• Frontend→Backend communication via REST endpoints under /api/v1.
• Backend uses MongoDB as primary datastore.
• Integration with external services:
• Google Maps API for geolocation and route optimization.
• Twilio for SMS notifications.
• Cloudinary for image/file uploads.
• Flask service provides predictive‑analytics endpoints consumed by the backend.
• Containerization via Docker Compose.
Main components
a. User Roles (actors): Donor App (Restaurant/Caterer UI), Recipient App (NGO/Volunteer UI), Administrator.
b. Frontend: React.js SPA served from Frontend container.
c. Backend: Express.js API server (handles auth, business logic, routes).
d. AI Microservice: Flask app exposing prediction/chatbot endpoints.
e. Datastore: MongoDB instance (with potential Redis cache for real‑time leaderboard or OTP storage, implied by volunteerRedistribute.model).
f. External Services: Google Maps API, Twilio SMS API, Cloudinary (media storage).
g. DevOps: Docker Compose orchestration, Azure Pipelines for CI/CD.
Component relationships and data flows
• Frontend → Backend (REST calls).
• Backend → MongoDB (driver calls).
• Backend → Flask microservice (HTTP or RPC).
• Backend → External APIs (Google Maps, Twilio, Cloudinary).
• Backend scheduling real‑time notifications to users.
Architectural patterns and design principles
• MVC pattern in the backend (controllers, models, routes).
• Component‑based and page‑based architecture in React.
• Microservice for AI/ML separation (Flask).
• Containerization for environment consistency and scaling.
• Role‑based access control via middleware.