Welcome to the comprehensive technical documentation for the ISSA Foundation platform. This repository serves as the definitive operational and architectural manual for PineBrook Technologies.
Caution
Zero Plaintext Secrets Policy: This repository never stores live passwords, API tokens, cookie secrets, private keys, or production database connection strings. All configuration parameters are documented as environment variable names and vault paths.
- Production URL: issafoundation.co.in
- Staff Operations Panel: https://issafoundation.co.in/panel
- Application Framework: Next.js 16 (App Router) with React 19 & TypeScript 5.9
- Primary Database: Neon Serverless PostgreSQL (18 Tables, JSONB Content,
BYTEABinary Storage) - Identity Provider: Neon Auth (Email OTP for
@pinebrooktechnologies.com) - Hosting & CDN: Vercel Serverless Platform with Cloudflare DNS
- Source Code Repository:
https://github.com/pineBrook/issa.git
All core system documentation is organized within the docs/ directory:
| Document | Primary Focus & Domain | Target Audience | Key Contents |
|---|---|---|---|
| docs/01_system_architecture.md | System Architecture & Data Flow | All Engineers, Architects | Full context diagrams, Next.js Server Actions, sequence workflows (CMS, Careers, Auth), failure boundaries. |
| docs/02_database_schema.md | Database Schema & Data Model | Database Admins, Backend | ER diagrams, 18-table column catalog, JSONB schemas, chronological migrations, SQL troubleshooting recipes. |
| docs/03_deployment_environments_configuration.md | Deployment, Envs & Config | DevOps, Developers | Environment isolation, variable register, local setup, deployment runbook, Vercel instant rollback. |
| docs/04_repository_ownership_access.md | Repository Ownership & Access | Tech Leads, Repository Admins | Ownership register, GitHub branch protection, CODEOWNERS map, contribution flow, employee JML lifecycle. |
| docs/05_infrastructure_services_credentials.md | Cloud Services & Credentials | Security, DevOps, On-Call | Cloud service registry, credential metadata vault, step-by-step secret rotation runbooks, break-glass procedures. |
| docs/06_operations_maintenance.md | Operations & Maintenance | On-Call Staff, SREs | SLAs (SEV-1 to SEV-4), daily/monthly checklists, PITR database restores, 5 common operational runbooks. |
| docs/07_knowledge_transfer_handover.md | Knowledge Transfer & Handover | Incoming & Outgoing Leads | 7 structured training sessions, 10 unprompted acceptance exercises, sign-off table, 30-day transition timeline. |
| docs/08_api_and_application_map.md | APIs & Application Map | Full-Stack Engineers, QA | REST API inventory, Staff Operations Panel (8 functional modules), RBAC capability matrix, codebase file tree. |
| docs/09_security_privacy_risk_register.md | Security, Privacy & Risks | Security Lead, Management | Defense-in-depth architecture, personal data (PII) inventory, detailed risk breakdowns (R-01 to R-12), audit checklist. |
| docs/10_standard_project_documentation_template.md | Documentation Standard | Tech Leads, PMO | Standard folder structure, required sections, and documentation governance rules for future Pine Brook projects. |
| docs/11_open_items_and_decisions.md | Open Items, ADRs & Finalisation | Project Owners, Tech Leads | Governance action tracker (Active / Open items only), Architectural Decision Records (ADRs), Phase 3 completion criteria. |
If you are a new engineer or maintainer joining the project:
- Read docs/01_system_architecture.md to understand the overall architecture and data flow.
- Follow docs/03_deployment_environments_configuration.md to install Bun and run the project locally on port 5000.
- Review docs/08_api_and_application_map.md and docs/06_operations_maintenance.md to explore the
/paneldashboard and learn how to triage common operational issues.