# Helmyx — SaaS Project Management Platform

A fully-featured multi-tenant project management SaaS built with **PHP 8.2 + MySQL 8.0**. Designed for organizations that manage multiple client projects with external contractors and suppliers.

> **On the name** (per `Helmyx-Brand-Assets/Helmyx-Brand-Guide.html`, the official brand guide): "The name fuses **helm** — the wheel a ship is steered by, the seat of control — with **-yx**, an invented software suffix that keeps the word ownable rather than a plain dictionary term. The mark says the same thing twice: a ship's wheel for control, and a rising double chevron for progress." Tagline: **"Steer. Plan. Deliver."**

## Quick Start

1. **Import database**: `sql/schema.sql` → phpMyAdmin → `projectpulse` database
2. **Install dependencies**: `composer install` (or `C:\xampp\php\php.exe composer.phar install`)
3. **Configure**: Edit `config/config.php` (SMTP settings) and `config/database.php` (DB credentials)
4. **Enable mod_rewrite**: In Apache httpd.conf → `AllowOverride All`
5. **Access**: http://localhost/Prodcat

**Default login**: `admin@helmyx.com` / `Admin@1234`

## Modules

| Module | Description |
|---|---|
| Authentication | Login, OTP (TOTP), password reset, session management |
| Dashboard | Role-based dashboards (Org Admin, Contractor, Super Admin) |
| Projects | Full CRUD, milestone tracking, contractor assignment |
| Clients | Client registry with industry classification |
| Contractors | Company registry, document management, user access |
| Suppliers | Supplier registry with category management |
| Finance | Invoices, budgets, expenses, billing (0.5% subscription fee) |
| Reports | Custom report templates, daily progress reports with photos |
| Users & RBAC | Role-based access control, granular permissions |
| Notifications | In-app + email notifications for all key events |
| Settings | Org settings, 2FA, audit log, subscription management |

## Architecture

```
PHP 8.2 MVC (no framework)
├── core/ — Router, Controller, Model, View, Auth, Helpers
├── modules/ — Feature modules (controller + model + views)
├── config/ — Database & app configuration
├── assets/ — CSS design system + JavaScript
└── sql/ — Complete database schema (30+ tables)
```

## Key Features

- 🔐 Two-factor authentication (Google Authenticator / Authy)
- 🏢 Multi-tenant (multiple organizations on one installation)
- 💰 Automatic 0.5% subscription fee on Purchase Orders
- 📊 Financial analysis with Excel import
- 📸 Daily progress reports with photo uploads
- 🔄 Full project lifecycle (Draft → Active → Completed)
- 📧 Email notifications for all key workflow events
- 🌍 Multi-locale support (en_US, en_NG, fr_FR)
- 📱 Responsive design

## License

Private / Commercial Use Only
