How elhadj1101/employee-support-services works
Project type and purpose
• This is a full-stack web application called “Employee Support Services.”
• Purpose: Let employees submit loan or financial-aid requests online, enable committee members to review and approve/refuse/pay, and let the treasurer view analytics.
• Technologies: React frontend, Django + DRF backend, SQL (SQLite by default), local file storage for uploaded documents.
File structure
• Top-level directories:
• frontend/ — React SPA, organized into src (components, pages, api, store), public, config files (jsconfig, tailwind)
• backend/ — Django project (“backend” app), apps: authentication, funds_management, meetings, offres, requests
• Backend modules reflect core domains:
• authentication: user and role management, permissions, JWT/session
• requests: request models, documents, workflows
• funds_management: expense/income records, committees, balances
• meetings: meeting scheduling, minutes (PV)
• offres: offers or announcements
• Configuration & tooling:
• backend/settings.py, wsgi.py, asgi.py
• package.json + package-lock.json in both frontend and backend (npm tooling, possibly webpack)
• requirements.txt for Python dependencies
• manage.py for Django CLI
README for additional insights
• Describes user roles: employee, committee member, treasurer
• Mentions core flows: request creation + file upload, status tracking, committee actions, treasurer analytics
• Stack summary: React, Django, DRF, SQL
Elements
• Clear labels for each component (e.g., “React SPA”, “Auth Service”, “Requests API”)
• From Browser → React → API → DB/File Storage
• Back responses in opposite direction
• Blue rectangles for UI components
• Gray rectangles for backend services
• Parallel stacks for micro-modules within the API layer
Detailed breakdown
• Frontend:
• Component layer: LoginForm, Dashboard, RequestsTable, MeetingCalendar, Charts
• API clients: auth.js, requests.js, meetings.js, records.js, offres.js
• State management: store/index.js (Zustand)
• Backend:
• Django project entry: backend/backend/settings.py, urls.py
• Apps:
– authentication: User, Permissions, JWT/session flows
– requests: Request model, Document uploading
– funds_management: Record model, analytics endpoints
– meetings: Meeting model, PV docs
– offres: Offers model
• Shared utils: backend/backend/utils.py, app/utils.py
• Data stores:
• SQL database (tables for employees, requests, records, meetings, offers)
• File storage: /backend/documents/{year}/{id}/docs/*.pdf