How asifalthaf/crowdfunding works
Project Type and Purpose
• This is a full-stack crowdfunding platform (“CrowdFundingX”) where creators launch campaigns and investors fund them.
• Frontend: React + Vite + Tailwind CSS.
• Backend: Express.js REST API with MVC-style controllers, MongoDB for persistence, Cloudinary for media storage, and a payment gateway integration.
• Features include user/admin authentication (JWT), project CRUD, document uploads, real-time updates (WebSocket), and payment processing.
File Structure Analysis
• Top-level “backend” and “frontend” directories denote a clear separation of concerns.
• Backend:
• config/ (db.js, cloudinary.js)
• controllers/ (admin, auth, project, payment, document)
• models/ (User, Project, Investment, Document)
• routes/ (REST endpoints)
• middleware/ (auth, admin, rate limiter, error handler, file upload)
• utils/ (error formatting, standardized responses)
• server.js (app entry)
• Frontend:
• src/components & src/pages (UI components & route pages)
• src/services/api.js (HTTP client)
• src/store/*.js (state management)
• src/utils/socket.js (real-time communications)
• Vite/Tailwind configs.
Key Architecture Insights from README
• Full-stack, JWT-based auth, admin dashboard, MongoDB data store, Cloudinary for media, payment gateway for transactions.
a. Main Components
• Client Browser (React Single-Page App)
• API Gateway / Express Backend
• MongoDB Database
• Cloudinary (Media Storage)
• Payment Service (e.g., Stripe)
• WebSocket Server (real-time updates)
b. Relationships & Data Flow
1. Client ↔ Backend REST API (HTTPS)
2. Backend ↔ MongoDB (via Mongoose)
3. Backend ↔ Cloudinary (via cloudinary.js config) for file uploads/downloads
4. Backend ↔ Payment Gateway (payment.controller)
5. Client ↔ Backend WebSocket (socket.js) for live feeds (e.g., funding updates)
6. Admin Client ↔ Admin endpoints (protected by admin.middleware)
c. Architectural Patterns & Principles
• Backend follows MVC (models, controllers, routes) and layered middleware (auth, validation, error handling).
• Frontend is component-based, with a service layer for API calls and a store layer for state management.
• JWT tokens carry stateless auth; rateLimiter middleware prevents abuse.
• Separation of concerns: upload middleware abstracts file handling, utils centralize error/response formatting.
d. Key Technologies
• Frontend: React, Vite, Tailwind CSS, Zustand or similar state store, WebSocket (socket.io or native).
• Backend: Node.js, Express.js, Mongoose/MongoDB, Cloudinary SDK, JWT, Stripe (or similar), ESLint.
• DevOps: .env or config JSON for environment settings, scripts for admin user creation.