Smart Memo Tracking System

A comprehensive web-based memo management system built with PHP and MySQL for educational institutions. This system allows students, staff, and administrators to create, manage, track, and approve various types of memos and requests.

🚀 Features

Core Functionality

• User Management: Role-based access control (Student, Staff, Admin)
• Memo Creation: Template-based memo creation with file attachments
• Workflow Management: Automated approval workflows based on memo type
• Real-time Tracking: Visual workflow progress tracking
• Notification System: Email and in-app notifications
• Export System: Export data in JSON, CSV, Excel, and PDF formats
• File Management: Secure file upload and download system

User Roles & Permissions

Students

• Create and submit memos/requests
• Track memo status and progress
• View personal memo history
• Receive notifications on status updates
• Download approved memo documents

Staff

• Review and approve/reject assigned memos
• Add comments and feedback
• Manage department-specific requests
• View analytics and reports
• Create internal memos

Administrators

• Full system access and management
• User account management
• System configuration
• Comprehensive reporting
• Data export capabilities

🛠️ Technology Stack

• Backend: PHP 7.4+
• Database: MySQL 5.7+
• Frontend: HTML5, CSS3 (Tailwind CSS), JavaScript (Alpine.js)
• Charts: Chart.js
• Server: Apache (XAMPP compatible)

📋 Requirements

• PHP 7.4 or higher
• MySQL 5.7 or higher
• Apache Web Server
• XAMPP (recommended for local development)
• Modern web browser

🔧 Installation

Using XAMPP (Recommended)

1. Download and Install XAMPP

   • Download XAMPP from https://www.apachefriends.org/
   • Install and start Apache and MySQL services

2. Clone/Download the Project ```bash git clone [repository-url]

   OR download and extract the ZIP file

   ```

3. Move to XAMPP Directory

   • Copy the project folder to C:\xampp\htdocs\smart-memo-system\ (Windows)
   • Or /opt/lampp/htdocs/smart-memo-system/ (Linux)

4. Database Setup

   • Open phpMyAdmin: http://localhost/phpmyadmin
   • Create a new database named memo_system
   • Import the SQL file: database/schema.sql

5. Configure Database Connection

   • Edit config/database.php
   • Update database credentials if needed: ```php define('DB_HOST', 'localhost'); define('DB_NAME', 'memo_system'); define('DB_USER', 'root'); define('DB_PASS', ''); ```

6. Create Upload Directory

   • Create uploads/ folder in the project root
   • Set appropriate permissions (755 or 777)

7. Access the System

   • Open browser and go to: http://localhost/smart-memo-system/

👤 Default Login Credentials

Administrator

• Username: admin
• Password: admin123

Staff Member

• Username: dr.smith
• Password: admin123

Student

• Username: john.doe
• Password: admin123

📁 Project Structure

``` smart-memo-system/ ├── config/ │ └── database.php # Database configuration ├── includes/ │ ├── auth.php # Authentication functions │ ├── memo.php # Memo management functions │ ├── sidebar.php # Navigation sidebar │ └── header.php # Page header ├── database/ │ └── schema.sql # Database schema ├── uploads/ # File upload directory ├── components/ # Reusable PHP components │ ├── dashboards/ │ ├── memo/ │ └── ui/ ├── login.php # Login page ├── dashboard.php # Main dashboard ├── create-memo.php # Memo creation ├── inbox.php # Memo inbox ├── tracking.php # Progress tracking ├── view-memo.php # Memo details ├── users.php # User management (Admin) ├── settings.php # User settings ├── notifications.php # Notifications page ├── export.php # Data export ├── download.php # File download handler ├── logout.php # Logout handler └── README.md # This file ```

🔐 Security Features

• SQL Injection Protection: Prepared statements throughout
• XSS Prevention: Input sanitization and output encoding
• CSRF Protection: Form token validation
• Role-based Access Control: Granular permissions system
• Secure File Handling: File type validation and secure storage
• Session Management: Secure session handling

📊 Database Schema

The system uses the following main tables:

• users - User accounts and profiles
• memos - Memo/request records
• memo_workflow - Workflow tracking
• memo_comments - Comments and feedback
• memo_attachments - File attachments
• notifications - System notifications
• user_sessions - Session management

🎨 Customization

Adding New Memo Types

1. Update the type enum in the memos table
2. Add workflow template in includes/memo.php
3. Update form options in create-memo.php

Modifying Workflows

Edit the getWorkflowTemplate() method in includes/memo.php to customize approval workflows for different memo types.

Styling Changes

The system uses Tailwind CSS. Modify the HTML classes or add custom CSS as needed.

🐛 Troubleshooting

Common Issues

1. Database Connection Error

   • Check MySQL service is running
   • Verify database credentials in config/database.php
   • Ensure database exists and schema is imported

2. File Upload Issues

   • Check uploads/ directory exists and has write permissions
   • Verify PHP upload_max_filesize and post_max_size settings

3. Login Issues

   • Ensure default users are created (check database/schema.sql)
   • Clear browser cache and cookies
   • Check session configuration

4. Permission Errors

   • Verify file/folder permissions
   • Check Apache configuration
   • Ensure PHP has necessary extensions enabled

📈 Performance Optimization

• Database indexes are included for optimal query performance
• File uploads are stored outside web root for security
• Session cleanup routines prevent session table bloat
• Pagination implemented for large data sets

🔄 Backup and Maintenance

Regular Backups

• Database: Export via phpMyAdmin or mysqldump
• Files: Backup the entire project directory
• Uploads: Separately backup the uploads folder

Maintenance Tasks

• Clean old sessions periodically
• Archive old memos if needed
• Monitor disk space for uploads
• Update user passwords regularly

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Test thoroughly
5. Submit a pull request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

📞 Support

For support and questions:

• Create an issue in the repository
• Check the troubleshooting section
• Review the code documentation

🚀 Future Enhancements

• Email integration for notifications
• Mobile responsive improvements
• API endpoints for mobile app
• Advanced reporting and analytics
• Integration with external systems
• Multi-language support

---

Note: This system is designed for educational institutions but can be adapted for other organizations with similar memo/request management needs. ```

Now let me create a setup script to help with installation: