Flowcode Documentation Index

Last Updated: 2025-11-16 Documentation Version: 1.2.0 Scan Type: Exhaustive Full Rescan

---

Project Overview

• Type: Monolithic Full-Stack Web Application
• Primary Language: PHP 8.3 + TypeScript
• Architecture: Multi-Tenant SaaS
• Framework: Laravel 12 + Vue 3 + Inertia.js v2

Quick Reference

• Tech Stack: Laravel 12 + Vue 3 + Filament 3 + Pinia + Tailwind CSS 3 + Vite
• Entry Point: public/index.php (web), resources/ts/app.ts (frontend)
• Architecture Pattern: Layered monolith with multi-panel admin
• Codebase Size: 719 Vue components, 176 models, 98 controllers, 396 migrations

---

Generated Documentation

Core Documentation

• Project Overview - Executive summary and feature overview
• Architecture - System design, patterns, and technical architecture
• Source Tree Analysis - Complete codebase structure with annotations
• Development Guide - Setup, workflow, and development practices

Technical Documentation

• API Contracts - All API endpoints, authentication, and data contracts
• Data Models - 176 Eloquent models organized by domain

State & Progress

• Project Scan Report - Workflow state and scan results (JSON)

---

Existing Documentation

Authentication & Security

• Authentication Overview - Auth system documentation
• Firebase Integration - Firebase auth configuration

Business Decisions (ADRs)

• Business Decisions README - Decision record guidelines
• ADR Template - Template for new decisions
• 001 - Organization Import Active Default

Creator System

• Creator Panel - Creator interface documentation
• Element Fields - Field types and configuration
• Linked Fields - Field linking system
• File Management - Upload and file handling

Domain Models Documentation

• Catalogues - Catalogue system
• Catalogue Progress - Progress tracking
• Courses - Learning courses
• Department - Organizational departments
• Division - Organizational divisions
• Elements - Catalogue elements
• Element Feedback - Feedback system
• Fields - Data fields
• Field Progress - Field completion tracking
• Indicator Review Task - Compliance reviews
• Indicator Submission - Compliance submissions
• Indicator Task - Compliance tasks
• Lessons - Course lessons
• Lesson Attachments - Lesson materials
• Objectives - Strategic objectives
• Organisation - Tenant organizations
• Organisation Catalogues - Org-catalogue assignments
• Organisation Permissions - Permission system
• Organisation Roles - Role definitions
• Permissions - System permissions
• Projects - OPTT projects
• Reports - Reporting system
• Roles - Global roles
• Targets - KPI targets
• Tasks - OPTT tasks
• Units - Course units
• User - User model

OPTT System

• Objectives - OPTT objectives
• Projects - OPTT projects
• Tasks - OPTT tasks
• Targets - OPTT targets
• OPTT Attachments - File attachments

Indicators & Compliance

• Admin Indicators Dashboard
• Admin Indicators Submissions
• Indicators Entrepreneur Dashboard
• Indicator Notifications System
• Indicator System Submissions
• Indicator Verification
• Task Syncing

General System Features

• App Modules
• Backups
• Catalogue Element Progress
• Catalogue Modules
• Cloudflare Browser Rendering
• Dusk Testing
• Element Marking
• Element Notices
• Encryption
• Energy Points
• EnGauge Sessions
• Environment Setup
• Exports
• Flowcoders
• Graphics
• HTML Purification
• Imports
• Licenses (Legacy)
• Licences
• Linting
• Masked Dump
• Multitenancy
• Notifications
• Organisation Catalogues
• Organigram Analysis
• Organogram Functionality
• Reusable Session Scoring Component
• Session Clashes
• Session TODO
• SimplyBiz Environment Variables
• Tenant Clusters
• Tenant Portfolios
• Testing Infrastructure
• Typography

Organizations

• Organisation Management

REMS (External Integration)

• REMS Deployment Checklist
• REMS Environment Variables
• REMS Testing

Releases & Changelog

• Changelog
• Testing Infrastructure Refactoring 2025-10

Reporting

• Looker Studio Reports

Testing

• AI Services Test Coverage

Assets

• Element Icons

Other

• Programme Seats Without Organisation

---

Getting Started

For New Developers

1. Environment Setup

   git clone https://github.com/salthq/flowcode.git
   cd flowcode
   composer install
   npm install
   cp .env.example .env
   php artisan key:generate
   php artisan migrate --seed
   

2. Start Development

   npm run dev           # Frontend hot reload
   valet link flowcode   # Local server (Mac/Linux)
   valet secure flowcode # HTTPS
   

3. Run Tests

   php artisan test      # All tests
   vendor/bin/pint       # Code formatting
   

For Feature Development

1. Review Architecture Documentation for technical constraints
2. Check API Contracts for existing endpoints
3. Reference Data Models for domain understanding
4. Follow patterns in existing codebase

For AI-Assisted Development

When creating PRDs or working with AI assistants: 1. Point to this index as the primary reference 2. Use Architecture for technical context 3. Reference specific domain docs as needed 4. Check existing patterns before introducing new ones

---

Documentation Maintenance

Generated by Exhaustive Scan

The following files were auto-generated on 2025-11-16: - project-overview.md - architecture.md - source-tree-analysis.md - development-guide.md - api-contracts.md - data-models.md - project-scan-report.json

Update Schedule

• Major releases: Full rescan recommended
• Significant feature additions: Deep-dive scan on affected areas
• Routine maintenance: Keep existing docs current manually

Contribution

When adding new features: 1. Update relevant existing docs 2. Create new docs for major features 3. Add links to this index 4. Follow existing documentation patterns

---

Quick Links

• Repository: github.com/salthq/flowcode
• Main Branch: develop
• CI/CD: GitHub Actions
• Admin Panels: /admin-panel, /creator-panel, /org-panel
• Health Check: /health
• Monitoring: Laravel Pulse (production)

---

This documentation was generated using BMAD Method's Document Project Workflow (v1.2.0)