How usc-mike/dcism-intership-tracker works
Project’s Main Components
• Frontend User Interface:
– Found in the public/ directory (which contains pages for login, registration, and distinct subdirectories for coordinator and student functionalities).
• Backend Server Components:
– PHP controllers and configuration files (src/controllers and src/config) handle authentication, coordinator actions, and student actions.
– PHP scripts located in public (e.g., index.php, login.php) serve as entry points to the application.
• Database:
– The MySQL configuration is indicated in src/config/db.php, and this represents the persistence layer.
• Build/Development Tooling:
– Node-related files (package.json, server.js, postcss.config.js, tailwind.config.js, etc.) work together as part of the frontend build pipeline to compile Tailwind CSS and manage dependencies.
• Additional Resources:
– Report templates (in report_templates folder) and file uploads (in uploads folder) suggest document management features that support the internship tracking process.
Relationships and Interactions
• The Frontend (public/ folder) interfaces with the backend PHP controllers. Different URLs (e.g., /coordinator/* and /student/*) indicate role-based access.
• The PHP backend communicates with the MySQL database (via src/config/db.php); this is where data relating to users, reports, checklists, and evaluations are stored.
• Static assets (images, CSS) and document resources (templates, uploads) are served directly or referenced in the UI.
• The Node.js tooling supports the frontend build process (e.g., compiling and processing Tailwind CSS files), but it is not directly part of the runtime architecture of the application.
Important Architectural Patterns and Technologies
• The system is structured following a separation-of-concerns approach, splitting responsibilities between presentation (frontend) and business logic (backend).
• There is an implicit MVC-like pattern for the backend with controllers in src/controllers managing requests and business logic.
• Key technologies are HTML, Tailwind CSS, PHP, and MySQL. Node.js is in the mix as a build-time tool rather than a runtime service.
• The document management functionality (using folders for templates and uploads) is an important subsystem for handling internship report materials.
– “Frontend UI” with sub-labels for “Coordinator Portal” and “Student Portal.”
– “Backend Server (PHP)” containing components for authentication, coordinator actions, and student actions.
– “Database (MySQL)” to show where internship data, checklists, evaluation reports, and user information are stored.
– “Build & Asset Pipeline (Node.js)” to denote the process managing Tailwind CSS and frontend dependencies.
– From the “Frontend UI” to the “Backend Server” to indicate HTTP requests and responses.
– From the “Backend Server” to the “Database” to represent CRUD operations.