How saidshi4/texnoera-crm works
Project Type and Purpose
• It’s a monolithic, full-stack (backend-only) CRM service for course/institution management.
• Purpose: manage customers, courses, groups, payments, tasks, attendance, and send notifications.
File Structure and README
• Top-level build files (build.gradle, settings.gradle, gradle wrapper) indicate a Java/Gradle Spring Boot project.
• src/main/java/com/example/texnoeracrm contains:
– config (security, CORS, JWT filter, Swagger)
– controller (REST endpoints)
– service (business logic, including auth, scheduling)
– dao/entity & repository (JPA entities + Spring Data)
– mapper (entity ↔ DTO)
– model (DTOs for “get” and “set”)
– scheduler (cron jobs for attendance, tasks, notifications)
• External integrations: PostgreSQL (liquibase migrations) and Firebase (push notifications).
• Authentication: JWT via JwtAuthenticationFilter and SecurityConfiguration.
• DataLoader seeds initial data on startup.
Main Components
1. Clients
– Web or mobile front end or any HTTP client calling the REST API
2. API Layer (Spring Boot)
a. Security Layer
• JWTAuthenticationFilter
• AuthorizationInterceptor
• SecurityConfiguration
b. Web Layer (Controllers)
• AuthController
• UserController, GroupController, TaskController, etc.
c. Service Layer
• AuthService, JwtService
• UserService, GroupService, TaskService, AttendanceService, NotificationService, CommentService, UserTaskService
• SchedulerServices (AttendanceSchedulerService, TaskSchedulerService, NotificationSchedulerService)
d. Data Layer
• DAOs / Repositories (Spring Data JPA)
• Entities (UserEntity, TaskEntity, GroupEntity, etc.)
• Mappers (convert Entities ↔ DTOs)
3. Database
– PostgreSQL (liquibase drives schema migrations)
4. External System
– Firebase Cloud Messaging (via FirebaseMessagingService)
Relationships and Data Flow
• Client → HTTP Request → JWT Filter → Controller
• Controller delegates to appropriate Service
• Service uses Mappers + Repositories to read/write Entities in PostgreSQL
• SchedulerServices trigger on cron schedules → Service methods → DB or FCM
• NotificationService → FirebaseMessagingService → FCM
• DataLoader (on startup) → seeds DB
Architectural Patterns & Design Principles
• Layered architecture (Controller → Service → Repository)
• DTO pattern (separate model/get vs. model/set)
• Dependency injection (Spring Boot)
• JWT stateless authentication
• Externalized configuration (application.yml + Firebase JSON)
• Schema versioning via Liquibase
• Separation of concerns: config, auth, mapping, scheduling