How darshilpadmani/invoice works
Project’s Nature
• Full-stack web application for invoice/quote/customer management
• Frontend: React.js SPA with Ant Design
• Backend: Node.js/Express REST API
• Database: MongoDB (via Mongoose)
• Auxiliary services: PDF generation (Pug templates), email delivery, file-storage
Lay Out the Main High-Level Components
A. Client Browser (React SPA)
– UI Components & Presentation (frontend/src/components, modules, pages)
– State Management: React Context + Redux store
– Routing: React Router
– HTTP Client / Auth Service (frontend/src/auth + request layer)
B. API Server (Express.js)
– HTTP Server entrypoint (backend/src/app.js → server.js)
– Routers: appRoutes (business APIs) & coreRoutes (auth, public, downloads)
– Controllers:
• appControllers: invoice, quote, payment, client, taxes
• coreControllers: adminAuth, settings, setup
• pdfController for on-the-fly PDF generation
– Middlewares: auth, CRUD scaffolding, file-upload, settings/inventory injection, error handling
– Handlers: downloadHandler, errorHandlers
C. Database Layer (MongoDB)
– Collections & Mongoose Models under backend/src/models (appModels & coreModels)
D. File Storage (local FS)
– public/uploads via uploadMiddleware
E. External Services
– Email Service (SendEmailTemplate + SMTP or third-party)
Relationships & Data Flows
1. User interacts with React SPA → HTTP(S) requests to Express API
2. Express handles request via Router → Middleware chain → Controller
3. Controller invokes Mongoose Model → MongoDB CRUD
4. For PDF: Controller → pdfController uses Pug templates → returns binary/pdf
5. For emails: Controller → SendEmailTemplate → SMTP/third-party
6. File uploads: Controller + uploadMiddleware → saves to local disk → public folder
7. Responses return JSON or file stream back to SPA
Architectural Patterns & Technologies
• MVC-style on backend: Routers → Controllers → Models
• Layered Middlewares (auth, validation, settings injection)
• Component-based on frontend with container/presentational split
• State orchestration via React Context + Redux
• Service layer for HTTP, auth, error handling, success management
• Build tools: Vite/Rollup for frontend, nodemon/pm2 for backend