Welcome to the AutoClean documentation hub. This guide will help you understand, install, configure, and use AutoClean effectively.
- Installation Guide - Complete setup instructions for local and production environments
- Configuration - Environment variables, settings, and customization options
- Quick Start - Get up and running in 5 minutes
- Architecture Overview - System design, patterns, and structure
- Database Schema - Complete database documentation with relationships
- Features Guide - Detailed documentation of all features
- Development Guide - Local setup, workflow, and best practices
- API Reference - Livewire components, models, and services
- Testing - Test suite overview and testing guidelines
- Contributing - How to contribute to AutoClean
- Deployment Guide - Production deployment and server configuration
- User Guide - End-user documentation for admins and employees
- Changelog - Version history and recent changes
If you're an admin or employee using AutoClean:
- Read the User Guide
- Learn about Features
If you're setting up or contributing to AutoClean:
- Follow the Installation Guide
- Review the Development Guide
- Understand the Architecture
- Check the Contributing Guide
If you're deploying AutoClean to production:
- Review Installation requirements
- Follow the Deployment Guide
- Configure using the Configuration Reference
Physical locations or departments where work is performed. Each station has:
- Assigned employees
- Scheduled tasks
- Inventory items
- Time tracking logs
Work items that can be:
- One-time - Single occurrence tasks
- Recurring - Automatically scheduled based on patterns (daily, weekly, monthly, yearly)
- Template-based - Created from predefined templates
- Station-specific - Assigned to particular locations
- Admin - Full system access, manages stations, tasks, users, and settings
- Employee - Clock in/out, complete tasks, view reports
- Clock in/out at stations
- Automatic time log creation
- Time reports with PDF export
- Historical time data
- Track supplies per station
- Transaction history
- Low stock monitoring
- Usage patterns
- Navigate to Admin → Stations
- Click "Create Station"
- Enter station details
- Assign users to the station
- Add inventory items (optional)
- Go to Admin → Tasks
- Click "Create Task"
- Fill in task details
- Select recurrence pattern (daily/weekly/monthly/yearly)
- Assign to a station
- Save
- Navigate to Time Reports
- Select date range
- Filter by user/station (optional)
- Click "Generate Report"
- Export to PDF if needed
- PHP 8.2+
- MySQL 5.7+ or MariaDB 10.3+
- Node.js 18+
- 512MB RAM
- 500MB disk space
- PHP 8.3
- MySQL 8.0+ or MariaDB 10.6+
- Node.js 20+
- 1GB RAM
- 2GB disk space
- Redis for caching (optional)
- Browse the documentation files listed above
- Check the Architecture Guide for technical details
- Review Features for capabilities
- See common issues in Installation Guide
- Check logs with
php artisan pail - Review error messages in Laravel log files
- Report bugs via GitHub Issues
- Request features via GitHub Issues
- Contribute improvements via Pull Requests
| Document | Status | Last Updated |
|---|---|---|
| Installation | ✅ Complete | 2025-01-15 |
| Configuration | ✅ Complete | 2025-01-15 |
| Architecture | ✅ Complete | 2025-01-15 |
| Database Schema | ✅ Complete | 2025-01-15 |
| Features | ✅ Complete | 2025-01-15 |
| API Reference | ✅ Complete | 2025-01-15 |
| Development | ✅ Complete | 2025-01-15 |
| Testing | ✅ Complete | 2025-01-15 |
| Deployment | ✅ Complete | 2025-01-15 |
| User Guide | ✅ Complete | 2025-01-15 |
| Contributing | ✅ Complete | 2025-01-15 |
| Changelog | ✅ Complete | 2025-01-15 |
Navigation: Installation | Configuration | Architecture | Features | Development