How ketul-prajapati/fms-springboot works
Project Type and Purpose
• The system is a full-stack web application that targets educational institutions by providing modules for Admin, Faculty, and Students. Its purpose is to streamline administrative and academic management.
• The backend is built in Spring Boot (Java) and the frontend in React.js with Redux for state management. MongoDB is used as the database, and Firebase is leveraged for storage.
Main Components
a. Frontend Client:
– Built with React.js (with separate directories for different user roles: Admin, Faculty, Student).
– Handles user interface and interactions.
– Communicates with the backend via API calls.
b. Backend Server:
– Implemented using Spring Boot, following a layered architecture (controllers, services, repositories, models).
– Organized by feature domains (admin, faculty, student, and other academic resources like marks, materials, notifications, timetables, subjects).
– Exposes RESTful APIs for client consumption.
c. Database:
– MongoDB is used to store the application data (users, notices, timetables, academic records, etc.).
d. External Storage:
– Firebase is used for storing file-based resources (e.g., materials, possibly images or other media).
e. Supporting Services:
– Dockerfile is provided for the backend, which suggests containerization for deployment, and Maven (with Maven Wrapper) is used for build management.
Relationships and Interactions
• The Backend interacts with the MongoDB database for CRUD operations involving user data and academic records.
• The Backend also integrates with Firebase to manage storage of files and materials.
• In addition, there are internal relationships within the backend: controllers receive requests, services contain business logic, and repositories abstract database interactions.
Architectural Patterns and Design Principles
• Layered Architecture (presentation, service, persistence layers) within the backend.
• Modular approach by roles, with controllers and services separated by modules (admin, faculty, student, and others).
• Use of MVC paradigm in the backend controllers.
• Clear separation of concerns between frontend and backend.