EES — Documentation¶
Welcome. This is the single home for all engineering documentation about the EES (Employee Engagement Survey) product line. Everything here renders with live diagrams — no plugins or downloads needed to read it.
EES is made up of two related products:
- EES Report Portal — the admin/client-facing web app where survey results are analyzed (participation, benchmarks, demographic cuts, line-manager effectiveness, NPS, AI-generated insights).
- EES Survey Portal — the employee-facing web app where the engagement survey itself is taken (language selection, demographics, Likert-scale questions, review, submission).
Pick your document¶
-
:material-cog: EES Backend Documentation
The engineering reference for the Laravel backend that powers the Report Portal — architecture, controllers, business logic, API endpoints, database schema & ERD, security, and code review. Written for backend developers.
-
:material-language-javascript: EES Frontend Documentation
The onboarding & reference guide for the Report Portal frontend (
EES-V2.0-Frontend) — architecture, routing, pages, components, state management, API layer, and conventions. Written for frontend developers. -
:material-clipboard-text: Survey Portal Frontend Documentation
The onboarding & reference guide for the employee-facing Survey Portal (
EES-Survey-Portal) — the survey-taking flow, routing, components, Redux state, internationalization, and API layer. Written for frontend developers. -
:material-database-cog: Survey Portal Backend Documentation
The engineering reference for the Survey Portal's Laravel backend (
Ees-survey-backend) — the/survey-api/*endpoints, admin participant/invite management, WhatsApp & email integrations, database schema & ERD, security, and code review. Written for backend developers.
Who should read what¶
| You are… | Start with |
|---|---|
| Backend developer (Report Portal) | EES Backend Documentation (all sections) |
| Frontend developer (Report Portal) | EES Frontend Documentation (all sections) |
| Frontend developer (Survey Portal) | Survey Portal Frontend Documentation (all sections) |
| Backend developer (Survey Portal) | Survey Portal Backend Documentation (all sections) — read §15 Security first |
| New engineer, unsure where to start | Skim each document's §1 Introduction/Overview, then its architecture diagrams |
About this site¶
- This website is built automatically from Markdown files. When the documentation is updated, this site updates too.
- Every diagram you see is drawn live from the source (Mermaid) — the same source that developers edit.
- Use the search bar (top) to jump to anything, and the light/dark toggle for your preference.
Source of truth
The documents here are the official, current version. Each document ends with an "Unable to determine from the available code" appendix that honestly flags gaps and assumptions — if something is unclear or looks out of date, that's worth flagging so the docs can be corrected.
Known security issue — Survey Portal backend
The Survey Portal's /survey-api/* endpoints (questionnaire fetch, answer submission, reset/suspend/delete) currently have no authentication middleware, and the invite-link token they rely on instead is generated from a salt value that is never defined in config — meaning the effective token is likely predictable. See Survey Portal Backend Documentation → §15 Security for the full analysis before relying on this endpoint's access control.