How harishvinayagamoorthy/crm-mern works
Project type and purpose
• This is a full-stack MERN CRM application.
• Frontend: React.js (Vite), deployed via Netlify.
• Backend: Node.js + Express.js REST API (JWT-secured), MongoDB database.
• Purpose: Role-based CRM with Admin and User dashboards for managing users, tickets, and tasks.
File structure
• Top-level files:
• index.html, vite.config.js, netlify.toml → React build & deploy config
• .env → environment variables (API base URL, JWT secret)
• src/
• main.jsx, App.jsx → React app entry & root component
• components/ → reusable UI: Dashboard, spinners, context provider, hooks, utils (ApiService)
• pages/ → route pages: SignIn, Signup, Password reset, Admin & User task/ticket pages
• routes/AppRouters.jsx → React Router setup
• No server code present in this tree; presume backend lives in a separate repo or directory.
README for additional insights
• MERN stack: uses MongoDB, Express.js, React.js, Node.js.
• JWT for authentication, role-based access control.
• Admin vs. User features & CRUD operations.
Main components
a. Frontend SPA (React.js, Vite)
• Netlify CDN hosting
• React Router → AppRouters.jsx
• ContextProvider for global state (auth & theme)
• ApiService (utils/ApiService.jsx) for HTTP calls
• UI components: Dashboards, Charts, Forms
b. Backend REST API (Node.js + Express)
• Authentication routes (signin, signup, forgot/reset password)
• User/Ticket/Task CRUD controllers
• JWT middleware for route protection & role checks
c. Database (MongoDB)
• Collections: users, tickets, tasks
d. External services
• Email service for password reset
• Netlify (frontend CI/CD)
Relationships & interactions
• Browser → (HTTPS) → Netlify CDN → serves React SPA
• SPA → (HTTPS JSON) → Express API endpoints
• API → (MongoDB driver) → CRUD operations on DB
• Auth flow:
• User submits credentials → API issues JWT → SPA stores in Context/localStorage
• Subsequent API calls include JWT in Authorization header
• API middleware validates JWT & enforces Admin/User roles
Architectural patterns & design principles
• SPA with client-side routing (React Router)
• Layered API: Controllers → Services → Data access (Repository or direct Mongoose)
• Context + custom hooks (useLogout) for state & side-effects
• Component hierarchy: common, utils, context, hooks, pages
• Responsive & modular CSS (module.css per component)