Compare commits
5 Commits
e0170d71f5
...
claude
| Author | SHA1 | Date | |
|---|---|---|---|
| bcf0e3f3d1 | |||
| 3977c3652f | |||
| f4f191518c | |||
| 69272f71a3 | |||
| a6447970ac |
172
README.md
172
README.md
@@ -1,11 +1,13 @@
|
|||||||
# CPAS Violation Tracker
|
# CPAS Violation Tracker
|
||||||
|
|
||||||
Single-container Dockerized web app for CPAS violation documentation.
|
Single-container Dockerized web app for CPAS violation documentation and workforce standing management.
|
||||||
Built with React + Vite (frontend), Node.js + Express (backend), SQLite (database).
|
Built with **React + Vite** (frontend), **Node.js + Express** (backend), **SQLite** (database), and **Puppeteer** (PDF generation).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## The only requirement on your machine: Docker Desktop
|
## The only requirement on your machine: Docker Desktop
|
||||||
|
|
||||||
Everything else — Node.js, npm, React build — happens inside Docker.
|
Everything else — Node.js, npm, React build, Chromium for PDF — happens inside Docker.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -41,17 +43,87 @@ docker stop cpas-tracker && docker rm cpas-tracker
|
|||||||
docker run -d --name cpas-tracker -p 3001:3001 -v cpas-data:/data cpas-tracker
|
docker run -d --name cpas-tracker -p 3001:3001 -v cpas-data:/data cpas-tracker
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
### Company Dashboard
|
||||||
|
- Live table of all employees sorted by active CPAS points (highest risk first)
|
||||||
|
- Summary stat cards: total employees, elite standing (0 pts), with active points, at-risk count, highest active score
|
||||||
|
- **At-risk badge**: flags employees within 2 points of the next tier escalation
|
||||||
|
- Search/filter by name, department, or supervisor
|
||||||
|
- Click any employee name to open their full profile modal
|
||||||
|
|
||||||
|
### Violation Form
|
||||||
|
- Select existing employee or enter new employee by name
|
||||||
|
- **Employee intelligence**: shows current CPAS standing badge and 90-day violation count before submitting
|
||||||
|
- Violation type dropdown grouped by category; shows prior 90-day counts inline
|
||||||
|
- **Recidivist auto-escalation**: if an employee has prior violations of the same type, points slider auto-sets to maximum per policy
|
||||||
|
- Repeat offense badge with prior count displayed
|
||||||
|
- Context-sensitive fields (time, minutes late, amount, location, description) shown only when relevant to violation type
|
||||||
|
- **Tier crossing warning** (TierWarning component): previews what tier the new points would push the employee into before submission
|
||||||
|
- Point slider for discretionary adjustments within the violation's min/max range
|
||||||
|
- One-click PDF download immediately after submission
|
||||||
|
|
||||||
|
### Employee Profile Modal
|
||||||
|
- Full violation history with resolution status
|
||||||
|
- Negate / restore individual violations (soft delete with resolution type + notes)
|
||||||
|
- Hard delete option for data entry errors
|
||||||
|
- PDF download for any historical violation record
|
||||||
|
|
||||||
|
### CPAS Tier System
|
||||||
|
|
||||||
|
| Points | Tier | Label |
|
||||||
|
|--------|------|-------|
|
||||||
|
| 0–4 | 0–1 | Elite Standing |
|
||||||
|
| 5–9 | 1 | Realignment |
|
||||||
|
| 10–14 | 2 | Administrative Lockdown |
|
||||||
|
| 15–19 | 3 | Verification |
|
||||||
|
| 20–24 | 4 | Risk Mitigation |
|
||||||
|
| 25–29 | 5 | Final Decision |
|
||||||
|
| 30+ | 6 | Separation |
|
||||||
|
|
||||||
|
Scores are computed over a **rolling 90-day window** (negated violations excluded).
|
||||||
|
|
||||||
|
### PDF Generation
|
||||||
|
- Puppeteer + system Chromium (bundled in Docker image)
|
||||||
|
- Generated on-demand per violation via `GET /api/violations/:id/pdf`
|
||||||
|
- Filename: `CPAS_<EmployeeName>_<IncidentDate>.pdf`
|
||||||
|
- PDF captures prior active points **at the time of the incident** (snapshot stored on insert)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## API Reference
|
||||||
|
|
||||||
|
| Method | Endpoint | Description |
|
||||||
|
|--------|----------|-------------|
|
||||||
|
| GET | `/api/health` | Health check |
|
||||||
|
| GET | `/api/employees` | List all employees |
|
||||||
|
| POST | `/api/employees` | Create or upsert employee |
|
||||||
|
| GET | `/api/employees/:id/score` | Get active CPAS score for employee |
|
||||||
|
| GET | `/api/dashboard` | All employees with active points + violation counts |
|
||||||
|
| POST | `/api/violations` | Log a new violation |
|
||||||
|
| GET | `/api/violations/employee/:id` | Get violation history for employee (with resolutions) |
|
||||||
|
| PATCH | `/api/violations/:id/negate` | Negate a violation (soft delete + resolution record) |
|
||||||
|
| PATCH | `/api/violations/:id/restore` | Restore a negated violation |
|
||||||
|
| DELETE | `/api/violations/:id` | Hard delete a violation |
|
||||||
|
| GET | `/api/violations/:id/pdf` | Download violation PDF |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Project Structure
|
## Project Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
cpas-violation-tracker/
|
cpas/
|
||||||
├── Dockerfile # Multi-stage: builds React + runs Express
|
├── Dockerfile # Multi-stage: builds React + runs Express w/ Chromium
|
||||||
├── .dockerignore
|
├── .dockerignore
|
||||||
├── package.json # Backend (Express) deps
|
├── package.json # Backend (Express) deps
|
||||||
├── server.js # API + static file server
|
├── server.js # API + static file server
|
||||||
├── db/
|
├── db/
|
||||||
│ ├── schema.sql # Tables + 90-day score view
|
│ ├── schema.sql # Tables + 90-day active score view
|
||||||
│ └── database.js # SQLite connection
|
│ └── database.js # SQLite connection (better-sqlite3)
|
||||||
|
├── pdf/
|
||||||
|
│ └── generator.js # Puppeteer PDF generation
|
||||||
└── client/ # React frontend (Vite)
|
└── client/ # React frontend (Vite)
|
||||||
├── package.json
|
├── package.json
|
||||||
├── vite.config.js
|
├── vite.config.js
|
||||||
@@ -60,14 +132,84 @@ cpas-violation-tracker/
|
|||||||
├── main.jsx
|
├── main.jsx
|
||||||
├── App.jsx
|
├── App.jsx
|
||||||
├── data/
|
├── data/
|
||||||
│ └── violations.js # All CPAS violation definitions
|
│ └── violations.js # All CPAS violation definitions + groups
|
||||||
|
├── hooks/
|
||||||
|
│ └── useEmployeeIntelligence.js # Score + history hook
|
||||||
└── components/
|
└── components/
|
||||||
└── ViolationForm.jsx
|
├── CpasBadge.jsx # Tier badge + color logic
|
||||||
|
├── TierWarning.jsx # Pre-submit tier crossing alert
|
||||||
|
├── Dashboard.jsx # Company-wide leaderboard
|
||||||
|
├── ViolationForm.jsx # Violation entry form
|
||||||
|
├── EmployeeModal.jsx # Employee profile + history modal
|
||||||
|
├── NegateModal.jsx # Negate/resolve violation dialog
|
||||||
|
└── ViolationHistory.jsx # Violation list component
|
||||||
```
|
```
|
||||||
|
|
||||||
## Phases
|
---
|
||||||
- [x] Phase 1 — Container scaffold, SQLite schema, base React form
|
|
||||||
- [ ] Phase 2 — Employee history, prior violation highlighting
|
## Database Schema
|
||||||
- [ ] Phase 3 — Puppeteer PDF generation
|
|
||||||
- [ ] Phase 4 — Dashboard, CPAS scores, tier warnings
|
Three tables + one view:
|
||||||
- [ ] Phase 5 — Recidivist point auto-suggest
|
|
||||||
|
- **`employees`** — id, name, department, supervisor
|
||||||
|
- **`violations`** — full incident record including `prior_active_points` snapshot at time of logging
|
||||||
|
- **`violation_resolutions`** — resolution type, details, resolved_by (linked to violations)
|
||||||
|
- **`active_cpas_scores`** (view) — sum of points for non-negated violations in rolling 90 days, grouped by employee
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Roadmap
|
||||||
|
|
||||||
|
### ✅ Completed
|
||||||
|
|
||||||
|
| Phase | Feature | Description |
|
||||||
|
|-------|---------|-------------|
|
||||||
|
| 1 | Container scaffold | Docker multi-stage build, Express server, SQLite schema |
|
||||||
|
| 1 | Base violation form | Employee fields, violation type, incident date, point submission |
|
||||||
|
| 2 | Employee intelligence | Live CPAS standing badge and 90-day count shown before submitting |
|
||||||
|
| 2 | Prior violation highlighting | Violation dropdown annotates types with 90-day recurrence counts |
|
||||||
|
| 2 | Recidivist auto-escalation | Points slider auto-maximizes on repeat same-type violations |
|
||||||
|
| 2 | Violation history | Per-employee history list with resolution status |
|
||||||
|
| 3 | PDF generation | Puppeteer/Chromium PDF per violation, downloadable immediately post-submit |
|
||||||
|
| 3 | Prior-points snapshot | `prior_active_points` captured at insert time for accurate historical PDFs |
|
||||||
|
| 4 | Company dashboard | Sortable employee table with live tier badges and at-risk flags |
|
||||||
|
| 4 | Stat cards | Summary counts: total, clean, active, at-risk, highest score |
|
||||||
|
| 4 | Tier crossing warning | Pre-submit alert when new points push employee to next tier |
|
||||||
|
| 4 | Employee profile modal | Full history, negate/restore, hard delete, per-record PDF download |
|
||||||
|
| 4 | Negate & restore | Soft-delete violations with resolution type + notes, fully reversible |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 🔲 Proposed
|
||||||
|
|
||||||
|
#### Reporting & Analytics
|
||||||
|
- **Violation trends chart** — line/bar chart of violations per day/week/month, filterable by department or supervisor; useful for identifying systemic patterns vs. individual incidents
|
||||||
|
- **Department heat map** — grid view showing violation density and average CPAS score by department; helps supervisors identify team-level risk
|
||||||
|
- **Expiration timeline** — visual showing which active violations will roll off the 90-day window and when, so supervisors can anticipate tier drops
|
||||||
|
- **CSV / Excel export** — bulk export of violations or dashboard data for external reporting or payroll integration
|
||||||
|
|
||||||
|
#### Employee Management
|
||||||
|
- **Employee edit / merge** — ability to update employee name, department, or supervisor without losing history; merge duplicate records created by name typos
|
||||||
|
- **Supervisor view** — scoped dashboard showing only the employees under a given supervisor, useful for multi-supervisor environments
|
||||||
|
- **Employee notes / flags** — free-text notes attached to an employee record (e.g. "on PIP", "union member") visible in the profile modal without affecting scoring
|
||||||
|
|
||||||
|
#### Violation Workflow
|
||||||
|
- **Acknowledgment signature field** — a "received by employee" name/date field on the violation form that prints on the PDF, replacing the blank signature line
|
||||||
|
- **Draft / pending violations** — save a violation as draft before finalizing, useful when incidents need review before being officially logged
|
||||||
|
- **Violation amendment** — edit a submitted violation's details (not points) with an audit trail, rather than delete-and-resubmit
|
||||||
|
- **Bulk violation import** — CSV import for migrating historical records from paper logs or a prior system
|
||||||
|
|
||||||
|
#### Notifications & Escalation
|
||||||
|
- **Tier escalation alerts** — email or in-app notification when an employee crosses into Tier 2+ so the relevant supervisor is automatically informed
|
||||||
|
- **Scheduled summary digest** — weekly email to supervisors listing their employees' current standings and any approaching tier thresholds
|
||||||
|
- **At-risk threshold configuration** — make the "at-risk" warning threshold (currently hardcoded at 2 pts) configurable per deployment
|
||||||
|
|
||||||
|
#### Infrastructure & Ops
|
||||||
|
- **Multi-user auth** — simple login with role-based access (admin, supervisor, read-only); currently the app has no auth and is assumed to run on a trusted internal network
|
||||||
|
- **Audit log** — immutable log of all creates, negates, restores, and deletes with timestamp and acting user, stored separately from the violations table
|
||||||
|
- **Automated DB backup** — cron job or Docker health hook to snapshot `/data/cpas.db` to a mounted backup volume or remote location on a schedule
|
||||||
|
- **Dark/light theme toggle** — the UI is currently dark-only; a toggle would improve usability in bright environments
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Proposed features are suggestions based on common HR documentation workflows. Priority and implementation order should be driven by actual operational needs.*
|
||||||
|
|||||||
@@ -2,19 +2,19 @@ import React, { useState } from 'react';
|
|||||||
|
|
||||||
const s = {
|
const s = {
|
||||||
wrapper: { marginTop: '24px' },
|
wrapper: { marginTop: '24px' },
|
||||||
title: { color: '#2c3e50', fontSize: '16px', fontWeight: 700, marginBottom: '10px' },
|
title: { color: '#b5b5c0', fontSize: '16px', fontWeight: 700, marginBottom: '10px' },
|
||||||
table: { width: '100%', borderCollapse: 'collapse', fontSize: '13px' },
|
table: { width: '100%', borderCollapse: 'collapse', fontSize: '13px', background: '#111217', borderRadius: '6px', overflow: 'hidden', border: '1px solid #222' },
|
||||||
th: { background: '#2c3e50', color: 'white', padding: '8px 10px', textAlign: 'left' },
|
th: { background: '#000000', color: '#f8f9fa', padding: '8px 10px', textAlign: 'left', fontSize: '12px', fontWeight: 600, textTransform: 'uppercase', letterSpacing: '0.5px' },
|
||||||
td: { padding: '8px 10px', borderBottom: '1px solid #dee2e6' },
|
td: { padding: '8px 10px', borderBottom: '1px solid #1c1d29', color: '#f8f9fa', verticalAlign: 'middle' },
|
||||||
trEven: { background: '#f8f9fa' },
|
trEven: { background: '#111217' },
|
||||||
trOdd: { background: 'white' },
|
trOdd: { background: '#151622' },
|
||||||
pts: { fontWeight: 700, color: '#667eea' },
|
pts: { fontWeight: 700, color: '#667eea' },
|
||||||
toggle: { background: 'none', border: 'none', color: '#667eea', cursor: 'pointer', fontSize: '13px', padding: 0, textDecoration: 'underline' },
|
toggle: { background: 'none', border: 'none', color: '#667eea', cursor: 'pointer', fontSize: '13px', padding: 0, textDecoration: 'underline' },
|
||||||
empty: { color: '#888', fontStyle: 'italic', fontSize: '13px', marginTop: '8px' },
|
empty: { color: '#77798a', fontStyle: 'italic', fontSize: '13px', marginTop: '8px' },
|
||||||
};
|
};
|
||||||
|
|
||||||
function formatDate(d) {
|
function formatDate(d) {
|
||||||
if (!d) return '—';
|
if (!d) return '–';
|
||||||
const dt = new Date(d + 'T12:00:00');
|
const dt = new Date(d + 'T12:00:00');
|
||||||
return dt.toLocaleDateString('en-US', { year: 'numeric', month: 'short', day: 'numeric', timeZone: 'America/Chicago' });
|
return dt.toLocaleDateString('en-US', { year: 'numeric', month: 'short', day: 'numeric', timeZone: 'America/Chicago' });
|
||||||
}
|
}
|
||||||
@@ -44,9 +44,9 @@ export default function ViolationHistory({ history, loading }) {
|
|||||||
<tr key={v.id} style={i % 2 === 0 ? s.trEven : s.trOdd}>
|
<tr key={v.id} style={i % 2 === 0 ? s.trEven : s.trOdd}>
|
||||||
<td style={s.td}>{formatDate(v.incident_date)}</td>
|
<td style={s.td}>{formatDate(v.incident_date)}</td>
|
||||||
<td style={s.td}>{v.violation_name}</td>
|
<td style={s.td}>{v.violation_name}</td>
|
||||||
<td style={s.td}>{v.category}</td>
|
<td style={{ ...s.td, color: '#c0c2d6' }}>{v.category}</td>
|
||||||
<td style={{ ...s.td, ...s.pts }}>{v.points}</td>
|
<td style={{ ...s.td, ...s.pts }}>{v.points}</td>
|
||||||
<td style={s.td}>{v.details || '—'}</td>
|
<td style={{ ...s.td, color: '#c0c2d6' }}>{v.details || '–'}</td>
|
||||||
</tr>
|
</tr>
|
||||||
))}
|
))}
|
||||||
</tbody>
|
</tbody>
|
||||||
|
|||||||
@@ -30,18 +30,12 @@ async function generatePdf(violation, score) {
|
|||||||
format: 'Letter',
|
format: 'Letter',
|
||||||
printBackground: true,
|
printBackground: true,
|
||||||
margin: {
|
margin: {
|
||||||
top: '0.6in',
|
top: '0.35in',
|
||||||
bottom: '0.7in',
|
bottom: '0.35in',
|
||||||
left: '0.75in',
|
left: '0.4in',
|
||||||
right: '0.75in',
|
right: '0.4in',
|
||||||
},
|
},
|
||||||
displayHeaderFooter: true,
|
displayHeaderFooter: false,
|
||||||
headerTemplate: '<div></div>',
|
|
||||||
footerTemplate: `
|
|
||||||
<div style="font-size:9px; color:#888; width:100%; text-align:center; padding:0 0.75in;">
|
|
||||||
CONFIDENTIAL — MPM Internal HR Document |
|
|
||||||
Page <span class="pageNumber"></span> of <span class="totalPages"></span>
|
|
||||||
</div>`,
|
|
||||||
});
|
});
|
||||||
|
|
||||||
return pdf;
|
return pdf;
|
||||||
|
|||||||
597
pdf/template.js
597
pdf/template.js
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user