Project Documentation

Auto-generated from the codebase - always accurate, always up to date.

10 Features168 API Routes44 Templates12 Frameworksv2.3.0
10
Features
168
API Endpoints
44
Code Templates
12
Compliance Frameworks
21
Client Pages
4
Doc Files

Project Documentation Files

README.md
1,674 words
Content Engineering Portfolio, Template Library & Compliance Knowledge Base Β· 🎯 Features Β· Public-Facing Β· Client Portal Β· Admin Dashboard Β· Compliance Knowledge Base …
SETUP.md
1,279 words
πŸŽ‰ Welcome Β· πŸ“‹ Prerequisites Β· πŸš€ Quick Start Β· 1. Install Dependencies Β· 2. Configure Environment Variables Β· Server Configuration …
docs/ADMIN-GUIDE.md
3,035 words
Admin User Guide Β· Structured for Growth - Dashboard Administration Β· Table of Contents Β· Getting Started Β· System Requirements Β· First-Time Setup …
docs/CLIENT-GUIDE.md
1,571 words
Client User Guide Β· Welcome to Structured for Growth Β· Table of Contents Β· Getting Started Β· What You Can Do Here Β· Homepage Navigation …
Method Endpoint Auth Module Description
GET /api/health None core Health check endpoint
GET /api/accessibility/dashboard Token accessibility ────────────────────────────────────────────────────────────
POST /api/accessibility/scan Token accessibility ────────────────────────────────────────────────────────────
GET /api/accessibility/trends Token accessibility ────────────────────────────────────────────────────────────
GET /api/accessibility/remediation Token accessibility ────────────────────────────────────────────────────────────
POST /api/accessibility/remediation Token accessibility -
PUT /api/accessibility/remediation/:id Token accessibility -
GET /api/accessibility/vpat-data Token accessibility ────────────────────────────────────────────────────────────
POST /api/ai/orchestrate Token ai ────────────────────────────────────────────────────────────
POST /api/ai/generate-document Token ai ────────────────────────────────────────────────────────────
POST /api/ai/gap-analysis Token ai ────────────────────────────────────────────────────────────
GET /api/ai/agents Token ai ────────────────────────────────────────────────────────────
GET /api/ai/audit Token ai ────────────────────────────────────────────────────────────
GET /api/ai/audit/stats Token ai -
GET /api/ai/reviews Token ai ────────────────────────────────────────────────────────────
GET /api/ai/reviews/stats Token ai -
GET /api/ai/reviews/:id Token ai -
POST /api/ai/reviews/:id/approve Token ai -
POST /api/ai/reviews/:id/reject Token ai -
GET /api/ai/cost Token ai ────────────────────────────────────────────────────────────
GET /api/ai/cost/summary Token ai -
PUT /api/ai/cost/budget Token ai -
GET /api/ai/evaluation/suite Token ai ────────────────────────────────────────────────────────────
POST /api/ai/evaluation/run Token ai -
GET /api/api-docs/openapi.json None api-docs Serve OpenAPI spec as JSON
GET /api/api-docs None api-docs Serve a simple Swagger UI-like documentation page
POST /api/assist None assist ── Route ─────────────────────────────────────────────────────────────────────
POST /api/auth/register None auth Register new user
POST /api/auth/login None auth Login
GET /api/auth/verify None auth Verify token
POST /api/auth/change-password Token auth Change password
GET /api/auth/profile Token auth Get current user profile
POST /api/auth/refresh None auth P3.2.3 β€” Refresh access token using a valid refresh token (rotation)
POST /api/auth/logout None auth P3.2.3 β€” Logout: revoke refresh token(s)
GET /api/auth/users Token auth Get all users (admin only)
POST /api/auth/users Token auth Create user (admin only)
PUT /api/auth/users/:id Token auth Update user (admin only)
DELETE /api/auth/users/:id Token auth Delete user (admin only)
GET /api/auth/activity Token auth Get activity log (admin only) β€” supports search, filter, pagination
GET /api/auth/activity/export Token auth Export activity log as CSV (admin only)
GET /api/backup/list Token backup List all backups
POST /api/backup/create Token backup Create a backup
GET /api/backup/download/:filename Token backup Download a backup
GET /api/backup/export Token backup Export current database (direct download without saving to file)
POST /api/backup/restore Token backup Restore from backup
DELETE /api/backup/:filename Token backup Delete a backup
GET /api/backup/settings Token backup Get/set backup settings
GET /api/backup/stats Token backup Get database statistics
GET /api/campaigns None campaigns Get all campaigns
GET /api/campaigns/segments/list None campaigns Get all segments
GET /api/campaigns/templates/list None campaigns Get all email templates
GET /api/campaigns/:id None campaigns Get single campaign with recipients
POST /api/campaigns None campaigns Create campaign
PUT /api/campaigns/:id None campaigns Update campaign
POST /api/campaigns/:id/send None campaigns Send campaign
DELETE /api/campaigns/:id None campaigns Delete campaign
POST /api/campaigns/segments None campaigns Create segment
DELETE /api/campaigns/segments/:id None campaigns Delete segment
POST /api/campaigns/templates None campaigns Create template
PUT /api/campaigns/templates/:id None campaigns Update template
DELETE /api/campaigns/templates/:id None campaigns Delete template
GET /api/clients None clients Get all clients with optional filtering
GET /api/clients/stats/overview None clients Get client statistics
GET /api/clients/:id None clients Get single client with projects
POST /api/clients None clients Create new client
PUT /api/clients/:id None clients Update client
DELETE /api/clients/:id None clients Delete client
POST /api/compliance-engine/evidence Token compliance-engine ────────────────────────────────────────────────────────────
GET /api/compliance-engine/evidence Token compliance-engine -
GET /api/compliance-engine/evidence/:id Token compliance-engine -
PUT /api/compliance-engine/evidence/:id Token compliance-engine -
DELETE /api/compliance-engine/evidence/:id Token compliance-engine -
GET /api/compliance-engine/gap-score Token compliance-engine -
GET /api/compliance-engine/gap-score/:framework Token compliance-engine -
POST /api/compliance-engine/assessments Token compliance-engine ────────────────────────────────────────────────────────────
GET /api/compliance-engine/assessments Token compliance-engine -
PUT /api/compliance-engine/assessments/:id Token compliance-engine -
GET /api/compliance-engine/export/poam Token compliance-engine -
GET /api/compliance/frameworks None compliance Returns all framework summaries in a single list
GET /api/compliance/frameworks/:id None compliance Returns a single framework by its ID (filename without .json)
GET /api/compliance/crossmap None compliance Returns the cross-framework mapping data
GET /api/compliance/templates None compliance Returns template metadata (the actual templates live in the Compliance-as-Code repo)
GET /api/compliance/oscal None compliance Returns list of available OSCAL catalogs
GET /api/compliance/oscal/:framework None compliance Returns a specific OSCAL catalog JSON
GET /api/compliance/evidence None compliance Returns evidence requirements matrix across all frameworks
GET /api/compliance/guidance/:framework None compliance Returns the implementation guide markdown for a framework
GET /api/compliance/lookup None compliance Returns the pre-built cross-framework lookup table (if available)
POST /api/contact None contact Contact form submission
POST /api/demo/generate Token demo Generate comprehensive demo data
GET /api/demo/stats Token demo Get demo data statistics
POST /api/demo/clear Token demo Clear demo data only (WHERE is_demo = 1)
GET /api/error-monitor None error-monitor -
GET /api/error-monitor/stats None error-monitor -
GET /api/error-monitor/:fingerprint None error-monitor -
PATCH /api/error-monitor/:fingerprint/resolve None error-monitor -
GET /api/fedramp/ssp None fedramp -
GET /api/fedramp/ssp/controls None fedramp -
GET /api/fedramp/ssp/control/:controlId None fedramp -
GET /api/fedramp/conmon/dashboard None fedramp -
GET /api/fedramp/conmon/poam None fedramp -
POST /api/fedramp/conmon/poam None fedramp -
PATCH /api/fedramp/conmon/poam/:id None fedramp -
POST /api/fedramp/conmon/scans None fedramp -
GET /api/fedramp/conmon/scans None fedramp -
POST /api/fedramp/conmon/changes None fedramp -
GET /api/fedramp/conmon/changes None fedramp -
PATCH /api/fedramp/conmon/changes/:id/approve None fedramp -
GET /api/mbai/manifest None mbai Returns the top-level manifest with pillars, categories, and template list
GET /api/mbai/templates None mbai Returns all templates in a single payload
GET /api/mbai/templates/:id None mbai Returns a single template by ID (filename without .json)
GET /api/mbai/categories None mbai Returns the list of business function categories
GET /api/messages None messages Get all conversations (grouped by client)
GET /api/messages/unread/count None messages Get unread count
GET /api/messages/client/:clientId None messages Get messages for a specific client
POST /api/messages/client/:clientId None messages Send message to client
POST /api/messages/bulk None messages Bulk message to multiple clients
DELETE /api/messages/:id None messages Delete a message
POST /api/mfa/setup Token mfa -
POST /api/mfa/verify Token mfa -
POST /api/mfa/validate None mfa -
DELETE /api/mfa Token mfa -
GET /api/mfa/status Token mfa -
POST /api/portal/login None portal POST /api/portal/login - Client portal login
GET /api/portal/me Client Token portal GET /api/portal/me - Get current client info
GET /api/portal/projects Client Token portal GET /api/portal/projects - Get client's projects
GET /api/portal/billing Client Token portal GET /api/portal/billing - Get billing/payment info
GET /api/portal/messages Client Token portal GET /api/portal/messages - Get client's messages
POST /api/portal/messages Client Token portal POST /api/portal/messages - Send a message (client to admin)
GET /api/projects None projects Get all projects with filtering
GET /api/projects/:id None projects Get single project with tasks
POST /api/projects None projects Create new project
PUT /api/projects/:id None projects Update project
DELETE /api/projects/:id None projects Delete project
POST /api/projects/:projectId/tasks None projects Create task
PUT /api/projects/:projectId/tasks/:taskId None projects Update task
DELETE /api/projects/:projectId/tasks/:taskId None projects Delete task
POST /api/projects/:projectId/time None projects Add time entry
GET /api/records Token records -
POST /api/records Token records -
GET /api/records/:id Token records -
PUT /api/records/:id Token records -
DELETE /api/records/:id Token records -
POST /api/records/:id/hold Token records -
DELETE /api/records/:id/hold Token records -
GET /api/records/holds/active Token records -
GET /api/records/disposition/log Token records -
GET /api/records/retention/schedules Token records -
GET /api/records/:id/versions Token records -
GET /api/records/:id/versions/:version Token records -
GET /api/records/:id/diff/:v1/:v2 Token records -
POST /api/records/:id/versions Token records -
GET /api/usace/templates Token usace ────────────────────────────────────────────────────────────
GET /api/usace/templates/:type Token usace -
GET /api/usace/sf298 Token usace ────────────────────────────────────────────────────────────
POST /api/usace/sf298/generate Token usace -
GET /api/usace/distribution-statements Token usace ────────────────────────────────────────────────────────────
POST /api/usace/distribution-statements/mark Token usace -
POST /api/usace/drchecks/export Token usace ────────────────────────────────────────────────────────────
GET /api/usace/mil-std-498 Token usace ────────────────────────────────────────────────────────────
GET /api/usace/mil-std-498/:type Token usace -
POST /api/usace/cdrl Token usace ────────────────────────────────────────────────────────────
GET /api/usace/cdrl Token usace -
GET /api/usace/cdrl/:id Token usace -
PUT /api/usace/cdrl/:id Token usace -
DELETE /api/usace/cdrl/:id Token usace -
GET /api/usace/nepa Token usace ────────────────────────────────────────────────────────────
GET /api/usace/nepa/:type Token usace -
GET /api/weather None weather -

Supporting Data

Package Info

NPM Scripts

Dependencies

Stylesheets

Client Pages