abeyakilesh/it-service-analyst-platform

1. Purpose and deployment shape

This is a MERN IT service-ticketing and analytics platform. It manages organizations, users/roles, ticket lifecycles, categories/SLAs, auditability, analytics, messaging, and notifications. The React/Vite client is intended for Vercel; the Express API for Render; MongoDB Atlas is the persistent store.

2. Client bootstrap, routing, and UI shell

The browser entry point mounts the React application, with application-level routing and role-aware dashboard selection. Authenticated pages are wrapped by shared navigation/layout components.

• client/src/main.jsx

• client/src/App.jsx

• client/src/routes/DashboardRouter.jsx

• client/src/components/ProtectedRoute.jsx

• client/src/layouts/MainLayout.jsx

3. Client state and API boundary

UI pages invoke domain-specific Axios API modules rather than calling the server directly. Axios centralizes API-base configuration and likely token/request behavior; Zustand stores retain authentication and theme state. This is the browser-to-REST boundary.

• client/src/api/axios.js

• client/src/api/authApi.js

• client/src/api/ticketApi.js

• client/src/store/authStore.js

• client/src/store/themeStore.js

4. User-facing workflows

Ticket listing, creation, and detail pages constitute the core operational workflow. Admin and user dashboards surface role-specific views; analytics and organization pages support management and reporting. Real-time notification UI is integrated into the shared client shell.

• client/src/pages/TicketListPage.jsx

• client/src/pages/TicketCreatePage.jsx

• client/src/pages/TicketDetailPage.jsx

• client/src/pages/AdminDashboard.jsx

• client/src/pages/AnalyticsPage.jsx

• client/src/components/NotificationListener.jsx

5. Express application pipeline

The backend starts from a server bootstrap and application composition layer, connects to MongoDB through Mongoose, and exposes route groups. Requests flow route → authentication/validation/error middleware → controller → Mongoose model → JSON response.

• server/server.js

• server/app.js

• server/config/db.js

• server/middleware/auth.js

• server/middleware/errorHandler.js

6. Identity, authorization, and tenancy

JWT-based registration/login/profile processing establishes the user identity consumed by protected routes. Roles (admin, analyst, user) govern protected operations and dashboard behavior. Organizations are a core tenancy/ownership dimension for tickets and reporting.

• server/routes/auth.js

• server/controllers/authController.js

• server/models/User.js

• server/routes/organizations.js

• server/models/Organization.js

7. Ticket, SLA, and traceability domain

Ticket controllers implement the main CRUD and status workflow. Tickets link users, organizations, categories, and SLA targets; category/SLA management defines service policy. Audit logs provide compliance-oriented history, while messages and notifications support collaboration and event delivery.

• server/controllers/ticketController.js

• server/models/Ticket.js

• server/models/ServiceCategory.js

• server/models/SLA.js

• server/controllers/auditLogController.js

• server/socket.js

8. Analytics and infrastructure boundaries

Analytics endpoints calculate or retrieve organization-level service metrics for dashboard consumption, with persisted report support. External runtime dependencies are Node.js/Express, React 18/Vite, MongoDB Atlas/Mongoose, JWT/bcrypt, Axios, and Socket-based real-time communication. Environment variables provide Mongo connection, JWT secret, API URL, and port boundaries.

• server/routes/analytics.js

• server/controllers/analyticsController.js

• server/models/AnalyticsReport.js

• client/src/api/analyticsApi.js