first commit
This commit is contained in:
60
README.md
60
README.md
@@ -0,0 +1,60 @@
|
|||||||
|
# mDMS - Modern Document Management System
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
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
|
||||||
Reference in New Issue
Block a user