PHPackages                             cstudios-slovakia/cleaner - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. cstudios-slovakia/cleaner

ActiveProject[Utility & Helpers](/categories/utility)

cstudios-slovakia/cleaner
=========================

PWA for cleaning management

v1.4.8(1mo ago)016MITPythonPHP >=8.0

Since May 5Pushed 4w agoCompare

[ Source](https://github.com/cstudios-slovakia/cleaning2)[ Packagist](https://packagist.org/packages/cstudios-slovakia/cleaner)[ RSS](/packages/cstudios-slovakia-cleaner/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependencies (2)Versions (33)Used By (0)

Cleaning System PWA
===================

[](#cleaning-system-pwa)

A premium Progressive Web Application (PWA) designed for managing cleaning properties, rooms, and assignments with a focus on real-time task tracking and personnel management.

✨ Version 1.4 Features
----------------------

[](#-version-14-features)

The system has been upgraded to **v1.4** with several major enhancements:

- **Relational Role Segregation (4 Levels)**: Separates operations between **Superadmin** (master configuration), **Admin** (regional control, assigned property management), **Manager** (localized supervisor), and **Cleaner** (mobile-first checking unit).
- **SMTP Outbound Socket Mailer & AI Summaries**: Sends beautiful daily HTML operational summaries automatically via socket-based SMTP, utilizing OpenAI ChatGPT-3.5 to compile concise daily executive reviews.
- **Smart Anti-Spam Filter**: Automatically skips email reports if none of the rooms cleaned today contain any general comments, note details, or reported problems, keeping management inboxes clean.
- **Outbox Email Logs & sandbox HTML Inspector**: Offers a dedicated management console to audit outgoing logs, filter by transmission statuses (Delivered/Failed), inspect raw transmission details, and render full daily HTML reports inside a sandboxed visual iframe previewer.
- **Dynamic "Cleaning" (In-Progress) Status**: Ticking the first checkbox in any active cleaner list instantly updates the property matrix on the dashboard to **"Cleaning"** (purple), providing supervisors with real-time room tracking.
- **Fluid Aurora Gradients & Glassmorphism Blur**: Features a dynamic, animated visual aurora backdrop with slow-gliding glowing blobs and a semi-translucent header with CSS backdrop filters.
- **Touch-Optimized Slideover Modals**: Overhauls core slideovers using React Portals (`createPortal` to `document.body` with `z-[100]`) and comfortable bottom layouts (`pb-32` scrolling) to prevent overlay blocking or notch clipping on iOS/Android browsers.

🚀 Quick Start (Production Deployment)
-------------------------------------

[](#-quick-start-production-deployment)

The easiest way to install the system on a live server is via Composer. This will download the latest stable version and the pre-built frontend.

```
composer create-project cstudios-slovakia/cleaner your-directory-name
```

After installation, navigate to the URL (e.g., `https://your-site.com/setup`) to complete the database configuration and create your admin account.

---

🛠 Manual Installation & Development
---------------------------------------

[](#-manual-installation--development)

If you want to contribute to development or set up the project manually, follow these steps.

### Prerequisites

[](#prerequisites)

- **PHP 8.1+** (with PDO MySQL extension)
- **MySQL/MariaDB**
- **Composer**
- **Node.js & NPM** (for frontend development)

### 1. Clone the Repository

[](#1-clone-the-repository)

```
git clone https://github.com/cstudios-slovakia/cleaning2.git
cd cleaning2
```

### 2. Backend Setup

[](#2-backend-setup)

Install PHP dependencies:

```
composer install
```

### 3. Frontend Setup

[](#3-frontend-setup)

Navigate to the frontend directory, install dependencies, and build the project:

```
cd frontend
npm install
npm run build
cd ..
```

The build process will output files to `frontend/dist`. To serve the application, copy these files to the project root:

```
cp -r frontend/dist/* .
```

### 4. Database Configuration

[](#4-database-configuration)

1. Create a new MySQL database.
2. Run the setup wizard by visiting `https://your-site.com/setup`.
3. Alternatively, you can manually create `api/config/db.php`: ```