🚀 Enterprise File Tracking System

A modern, secure, and scalable file management solution built for enterprise environments

🎯 Features • 🚀 Quick Start • 📖 Documentation • 🧪 Testing • 🚢 Deployment

---

🌟 Overview

The Enterprise File Tracking System is a comprehensive, production-ready file management platform designed for organizations that need robust file tracking, security, and collaboration capabilities. Built with modern technologies and enterprise-grade architecture, it provides a seamless experience for managing files across teams and departments.

✨ Key Highlights

• 🔐 Enterprise Security - JWT authentication, role-based access control, and audit trails
• 📁 Advanced File Management - Upload, organize, share, and track files with metadata
• 🔍 Intelligent Search - Advanced search capabilities with filters and categorization
• 👥 Multi-tenant Architecture - Department-based organization and user management
• 📊 Analytics & Reporting - Comprehensive audit trails and usage analytics
• 🌐 Modern UI/UX - Beautiful, responsive interface built with Radix UI and Tailwind CSS
• 🐳 Docker Ready - Containerized deployment with production configurations
• 🧪 Comprehensive Testing - Unit, integration, and E2E tests with 90%+ coverage

---

🎯 Features

🔐 Authentication & Authorization

• Secure Authentication - JWT-based authentication with bcrypt password hashing
• Role-Based Access Control - Admin, Manager, and User roles with granular permissions
• Session Management - Secure session handling with automatic token refresh
• Password Security - Strong password requirements and secure storage

📁 File Management

• Multi-Format Support - Images, documents, videos, presentations, spreadsheets, and archives
• Drag & Drop Upload - Intuitive file upload with progress tracking
• File Categorization - Organize files by category, department, and custom tags
• Version Control - Track file versions and changes over time
• Bulk Operations - Upload, download, and manage multiple files simultaneously

🔍 Advanced Search & Discovery

• Smart Search - Full-text search across file names, descriptions, and metadata
• Advanced Filters - Filter by file type, date range, department, and status
• Quick Access - Recent files and frequently accessed content
• Search Analytics - Track search patterns and popular content

👥 Collaboration & Sharing

• Secure File Sharing - Share files with specific users or departments
• Access Control - Granular permissions for shared files
• Collaboration Tools - Comments, annotations, and file discussions
• Notification System - Real-time notifications for file activities

📊 Analytics & Audit

• Comprehensive Audit Trail - Track all file operations and user activities
• Usage Analytics - File access patterns, storage usage, and user engagement
• Compliance Reporting - Generate reports for compliance and governance
• Activity Monitoring - Real-time monitoring of system activities

🎨 User Experience

• Modern Interface - Clean, intuitive design with dark/light theme support
• Responsive Design - Optimized for desktop, tablet, and mobile devices
• Accessibility - WCAG compliant with keyboard navigation and screen reader support
• Performance - Optimized loading times and smooth interactions

---

🛠 Technology Stack

Frontend

• Next.js 15.5.3 - React framework with App Router
• React 19 - Latest React with concurrent features
• TypeScript - Type-safe development
• Tailwind CSS - Utility-first CSS framework
• Radix UI - Accessible component primitives
• React Hook Form - Performant form handling
• Zod - Schema validation

Backend

• Node.js - JavaScript runtime
• Next.js API Routes - Serverless API endpoints
• MongoDB - NoSQL database
• Mongoose - MongoDB object modeling
• JWT - JSON Web Tokens for authentication
• bcryptjs - Password hashing

DevOps & Infrastructure

• Docker - Containerization
• Docker Compose - Multi-container orchestration
• GitHub Actions - CI/CD pipelines
• Playwright - End-to-end testing
• Jest - Unit and integration testing

---

🚀 Quick Start

Prerequisites

• Node.js 18+ and pnpm (or npm/yarn)
• Docker and Docker Compose
• MongoDB (local or cloud instance)

🐳 Docker Setup (Recommended)

1. Clone the repository

   git clone <repository-url>
   cd file-tracking-docker

2. Start with Docker Compose

   docker-compose up -d

3. Access the application

   • Application: http://localhost:3000
   • MongoDB Admin: http://localhost:8081 (admin/password)

4. Create demo admin user

   docker-compose exec app pnpm run setup:demo-admin

💻 Local Development Setup

1. Install dependencies

   pnpm install

2. Set up environment variables

   cp .env.example .env
   # Edit .env with your configuration

3. Start MongoDB (if not using Docker)

   # Using Docker
   docker run -d -p 27017:27017 --name mongodb mongo:7.0
   
   # Or use MongoDB Atlas cloud service

4. Run the development server

   pnpm dev

5. Create admin user

   pnpm run setup:admin

🔑 Default Credentials

After setup, use these credentials to access the system:

• Email: admin@filetracking.com
• Password: admin123

---

📖 Documentation

Environment Variables

Variable	Description	Default	Required
MONGODB_URI	MongoDB connection string	mongodb://localhost:27017/file-tracking	✅
JWT_SECRET	JWT signing secret (32+ chars)	-	✅
BASE_URL	Application base URL	http://localhost:3000	✅
MAX_FILE_SIZE	Maximum file size in bytes	52428800 (50MB)	✅
ALLOWED_FILE_TYPES	Comma-separated MIME types	See docker-compose.yml	✅
NODE_ENV	Environment mode	development	✅

API Endpoints

Authentication

• POST /api/auth/login - User login
• POST /api/auth/register - User registration
• POST /api/auth/logout - User logout
• GET /api/auth/verify - Verify JWT token

Files

• POST /api/files/upload - Upload files
• GET /api/files - List files with pagination
• GET /api/files/[id] - Get file details
• PUT /api/files/[id] - Update file metadata
• DELETE /api/files/[id]/delete - Delete file
• GET /api/files/[id]/download - Download file
• POST /api/files/[id]/share - Share file

Search

• GET /api/search - Search files
• GET /api/search/suggestions - Search suggestions
• GET /api/search/filters - Available filters

Admin

• GET /api/admin/users - List users
• POST /api/admin/users - Create user
• PUT /api/admin/users/[id] - Update user
• DELETE /api/admin/users/[id] - Delete user
• GET /api/admin/analytics - System analytics

Notifications

• GET /api/notifications - Get user notifications
• PATCH /api/notifications/[id]/read - Mark notification as read
• PATCH /api/notifications/mark-all-read - Mark all as read

Audit

• GET /api/audit/trail - Get audit trail
• GET /api/audit/stats - Get audit statistics
• GET /api/audit/export - Export audit report

---

🧪 Testing

The project includes comprehensive testing with high coverage:

Test Types

• Unit Tests - Individual component and function testing
• Integration Tests - API endpoint and database integration
• E2E Tests - Full user workflow testing with Playwright

Running Tests

# Run all tests
pnpm test

# Run tests in watch mode
pnpm test:watch

# Run with coverage
pnpm test:coverage

# Run integration tests
pnpm test:integration

# Run E2E tests
pnpm test:e2e

# Run E2E tests with UI
pnpm test:e2e:ui

Test Coverage

The project maintains high test coverage across all critical components:

• API Routes: 95%+ coverage
• Business Logic: 90%+ coverage
• Components: 85%+ coverage
• E2E Workflows: 100% critical paths

---

🚢 Deployment

🐳 Production Docker Deployment

1. Build production image

   docker build -f Dockerfile -t file-tracking-system .

2. Run with production compose

   docker-compose -f docker-compose.prod.yml up -d

☁️ Cloud Deployment

The system supports deployment to various cloud platforms:

Railway

# Deploy to Railway (configured in GitHub Actions)
git tag v1.0.0
git push origin v1.0.0

Render

# Deploy to Render (configured in GitHub Actions)
git push origin main

Manual Cloud Deployment

1. Set up environment variables in your cloud provider
2. Deploy the Docker image
3. Configure database connection
4. Set up file storage (if using cloud storage)

🔄 CI/CD Pipeline

The project includes automated CI/CD with GitHub Actions:

• Continuous Integration

  • Code quality checks (ESLint, TypeScript)
  • Security scanning (Snyk)
  • Unit and integration tests
  • E2E testing
  • Build verification

• Continuous Deployment

  • Automated Docker image building
  • Multi-environment deployment
  • Slack notifications
  • Rollback capabilities

---

🔧 Configuration

File Upload Configuration

// Supported file types
const ALLOWED_TYPES = [
  'image/*',           // Images
  'application/pdf',   // PDF documents
  'application/msword', // Word documents
  'text/plain',        // Text files
  'video/mp4',         // Videos
  'application/zip',   // Archives
  // ... and more
];

// File size limits
const MAX_FILE_SIZE = 50 * 1024 * 1024; // 50MB
const MAX_FILES_PER_UPLOAD = 10;

Security Configuration

// JWT Configuration
const JWT_CONFIG = {
  expiresIn: '7d',
  algorithm: 'HS256',
  issuer: 'file-tracking-system'
};

// Rate Limiting
const RATE_LIMITS = {
  upload: '10 requests per minute',
  api: '100 requests per minute',
  auth: '5 requests per minute'
};

---

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Workflow

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Add tests for new functionality
5. Ensure all tests pass (pnpm test)
6. Commit your changes (git commit -m 'Add amazing feature')
7. Push to the branch (git push origin feature/amazing-feature)
8. Open a Pull Request

Code Standards

• TypeScript - All code must be properly typed
• ESLint - Follow the configured linting rules
• Testing - Maintain test coverage above 85%
• Documentation - Update docs for new features

---

📄 License

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

---

🆘 Support

Getting Help

• Documentation: Check the docs in the /docs folder
• Issues: Report bugs via GitHub Issues
• Discussions: Join GitHub Discussions for questions
• Email: Contact the development team

Common Issues

🐛 MongoDB Connection Issues

Problem: Cannot connect to MongoDB

Solutions:

1. Ensure MongoDB is running: docker ps
2. Check connection string in .env
3. Verify network connectivity
4. Check MongoDB logs: docker logs mongodb

🔐 Authentication Problems

Problem: JWT token issues

Solutions:

1. Verify JWT_SECRET is set and 32+ characters
2. Clear browser storage and cookies
3. Check token expiration settings
4. Restart the application

📁 File Upload Failures

Problem: Files not uploading

Solutions:

1. Check file size limits (MAX_FILE_SIZE)
2. Verify file type is allowed (ALLOWED_FILE_TYPES)
3. Ensure sufficient disk space
4. Check upload directory permissions

---

🙏 Acknowledgments

• Next.js Team - For the amazing React framework
• Radix UI - For accessible component primitives
• Tailwind CSS - For the utility-first CSS framework
• MongoDB - For the flexible database solution
• Open Source Community - For the incredible tools and libraries

---

Built with ❤️ for enterprise file management

⭐ Star this repo • 🐛 Report bug • 💡 Request feature