How aniketdey06/jis_rnd_website works
Project Type & Purpose
• This is a full-stack web application built for managing research grant applications and project progress tracking.
• Its main user groups are faculty (applying and submitting progress reports) and RFMO administrators (managing and approving applications, monitoring project status).
• The technology stack comprises front-end (HTML, CSS, JavaScript), back-end (PHP), and a MySQL database. Additionally, external libraries such as PHPMailer are used for email functionalities.
File Structure
• Top-Level Folders:
• “admin”: Contains PHP files for various administrative tasks such as dashboards, approving applications, updating status, and reporting.
• “assets”: Holds CSS files, JavaScript files (e.g., a register.js), and images – all part of the front-end static assets.
• “config”: Contains configuration files (e.g., database.php) for connecting to MySQL.
• “forms”: Provides PDF-based progress reports and submission forms, and handles file uploads.
• “includes”: Shared code fragments (e.g., headers, footers, common functions) used throughout the site.
• “template”: Contains page templates for different user interfaces (faculty dashboards, login, registration, password recovery, etc.).
• “utils”: Contains authentication controllers, email handling, data deletion, and other utility scripts which encapsulate common business logic.
• Other files like SQL scripts (rnd_website.sql, posts.sql, project_allocation.sql) are used to set up and maintain the database schema.
Key Architectural Components
a. Frontend Components:
• User Interface:
• Faculty templates (from the “template” folder) and associated assets under “assets”.
• Separate views/pages for faculty and administrators.
• Client-Side Interactions:
• HTML, CSS, and JavaScript files provide the responsive interface.
b. Backend Components:
• PHP-based business logic split into:
• “admin” directory for administrative functionalities.
• “utils” for authentication, email handling (PHPMailer integration), and status updates.
• “includes” for reusable code (headers, footers, common functions).
• “forms” to handle file uploads and submissions.
• Server configuration managed via files in “config” (e.g., database.php).
c. Database:
• A MySQL database is used (with schema provided through SQL files like rnd_website.sql).
• Data flows include user information, grant applications, progress reports, and project status.
d. External Integration:
• PHPMailer for email notifications (located in the phpMailer folder).
Relationships and Data Flow
• Faculty and Administrators interact with the system via the browser.
• The front-end communicates with the backend PHP scripts, which in turn interact with the MySQL database.
• Utility scripts (in “utils”) handle authentication, password management, file uploads, and email notifications.
• The “admin” section has dedicated endpoints for managing application approval, dashboard summaries, and report displays.
• File uploads (from the “forms/uploads” directories) are managed and later referenced in the database or displayed via templates.
Architectural Patterns & Design Principles
• Separation of Concerns: Distinct folders segregate front-end (assets, templates) and back-end logic (admin, utils, includes).
• Modular Design: Utility functions (e.g., auth.php, functions.php) provide reusable services.
• MVC-like Separation: Although not a full MVC framework, the project distinguishes between view templates, processing logic, and data handling.
• Robust Security: Authentication and authorization appear to be handled via separate admin and faculty modules.