diff --git a/README.md b/README.md index e69de29..8ba7700 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,60 @@ +# mDMS - Modern Document Management System + +![PHP Version](https://img.shields.io/badge/PHP-8.1%2B-blueviolet) +![Laravel Version](https://img.shields.io/badge/Laravel-10.x-red) +![License](https://img.shields.io/badge/License-MIT-green) + +A robust document management system built with Laravel for modern organizations. Manage projects, documents, and team collaboration efficiently with version control, granular permissions, and full audit capabilities. + +## 🌟 Key Features + +- **Project Workspaces** - Organize documents in project-based containers +- **Hierarchical Folder Structure** - Unlimited nested folders with visual tree view +- **Document Management** + - Multi-file upload (Drag & Drop support) + - Version control with diff visualization + - File preview (PDF, Images, Office documents) +- **Advanced Security** + - Role-based access control (RBAC) + - Granular permissions (View/Edit/Delete/Share) + - File encryption at rest +- **Collaboration Tools** + - Comments & @mentions + - Approval workflows + - Audit logs with activity tracking +- **Smart Search** + - Full-text search with OCR capabilities + - Metadata filters (Type/Date/Status) +- **API Ready** - RESTful endpoints for integration +- **Responsive UI** - Mobile-friendly interface with dark/light modes + +## 🚀 Quick Start + +### Requirements +- PHP 8.1+ +- MySQL 5.7+ / PostgreSQL 13+ +- Composer 2.x +- Node.js 16.x+ + +### Installation +```bash +# Clone repository +git clone https://github.com/yourrepo/mdms.git +cd mdms + +# Install dependencies +composer install +npm install && npm run build + +# Configuration +cp .env.example .env +php artisan key:generate + +# Database setup +php artisan migrate --seed + +# Link storage +php artisan storage:link + +# Start server +php artisan serve \ No newline at end of file