Skip to content

Flowcode Project Overview

Generated: 2025-11-16

What is Flowcode?

Flowcode is an enterprise SaaS platform designed for business development, compliance management, and organizational learning. It provides multi-tenant organizations with tools for:

  • Business Catalogues: Structured frameworks for business planning and execution
  • Compliance Tracking: Indicator-based compliance monitoring and reporting
  • Project Management (OPTT): Objectives, Projects, Tasks, and Targets management
  • Session Management: Scheduled events with guides and facilitators
  • Knowledge Management: Knowledgebases, glossaries, courses, and resources
  • Organizational Structure: Divisions, departments, roles, and permissions

Executive Summary

Attribute Value
Type Full-Stack Monolithic Web Application
Architecture Multi-tenant SaaS
Primary Language PHP 8.3 (Backend) + TypeScript (Frontend)
Framework Laravel 12 + Vue 3 + Inertia.js
Admin Interface Filament 3 (3 panels)
Database MySQL with 396 migrations
Models 176 Eloquent models
UI Components 719 Vue components
Test Coverage 235 test files (Pest + Dusk)

Core Features

1. Multi-Tenant Organizations

  • Domain-based tenant identification
  • Organization-scoped data isolation
  • Custom roles and permissions per organization
  • Hierarchical structure (divisions, departments)

2. Business Catalogues

  • Versioned business frameworks
  • Structured elements with multiple tabs (primer, strategy, custom, etc.)
  • Field-level progress tracking
  • Graphics and visual assets
  • AI-powered analysis and insights

3. Compliance Management

  • Indicator-based compliance tracking
  • Monthly submission workflows
  • Review and verification processes
  • Success metric monitoring
  • Programme-level compliance reporting

4. OPTT System

  • Objectives: Strategic annual goals
  • Projects: Implementation initiatives
  • Tasks: Actionable work items
  • Targets: Measurable KPIs and metrics

5. Session Management

  • Scheduled events (EnGauge sessions)
  • Guide and facilitator assignments
  • Attendance tracking
  • Calendar integration (iCal feeds)
  • Clash detection

6. Knowledge Base

  • Organized knowledgebases
  • Categorized articles with feedback
  • Glossaries and term definitions
  • Courses and lessons
  • Resource libraries

Technology Highlights

Backend Excellence

  • Laravel 12: Latest stable framework with mature ecosystem
  • Multi-tenancy: Spatie package for robust tenant isolation
  • Queue Management: Laravel Horizon for job monitoring
  • Monitoring: Laravel Pulse + Nightwatch for production insights
  • Testing: Pest v4 for BDD-style testing

Frontend Innovation

  • Vue 3: Modern reactive UI with Composition API
  • Inertia.js v2: Server-side routing with SPA experience
  • PrimeVue: Enterprise-grade UI components
  • Tailwind CSS 3: Utility-first styling
  • TypeScript: Type-safe frontend development

Admin Power

  • Filament 3: Multi-panel admin with CRUD generation
  • 3 Distinct Panels: Super Admin, Creator, Organisation
  • Custom Components: Specialized forms and widgets

Key Integrations

  1. Firebase - User authentication
  2. AWS S3 - File storage and media
  3. OpenAI - AI-powered analysis features
  4. Mandrill - Transactional emails
  5. Slack - Team notifications
  6. Kraken.io - Image optimization

Development Maturity

Codebase Scale

  • 396 migrations = 4+ years of evolution
  • 176 models = comprehensive domain coverage
  • 98 controllers = extensive feature set
  • 719 Vue components = rich UI library
  • 235 tests = solid test foundation

Documentation

  • 96+ existing docs covering models, features, business decisions
  • Comprehensive README with setup instructions
  • CLAUDE.md for AI-assisted development
  • Architecture decision records (ADRs)

Quality Assurance

  • Pre-commit hooks (Pint + ESLint)
  • CI/CD with GitHub Actions
  • Automated browser testing (Dusk)
  • Performance monitoring (Pulse)

Domain Concepts

Core Entities

  • Organisation - Multi-tenant root entity
  • User - System users with memberships
  • Catalogue - Business knowledge frameworks
  • Element - Content units within catalogues
  • Field - Data fields with progress tracking
  • Indicator - Compliance metrics

Business Concepts

  • OPTT - Objective-Project-Task-Target hierarchy
  • Progress - User completion tracking at multiple levels
  • Compliance - Regulatory and operational requirements
  • Sessions - Facilitated learning events
  • Roles - Organization-specific role definitions

For New Developers

  1. Review docs/development-guide.md for setup
  2. Explore docs/source-tree-analysis.md for codebase structure
  3. Study docs/architecture.md for system design
  4. Check docs/data-models.md for domain understanding

For Feature Development

  1. Reference docs/api-contracts.md for existing APIs
  2. Check existing docs in docs/models/ for domain knowledge
  3. Use Laravel Boost MCP for documentation queries
  4. Follow patterns in existing code

For Brownfield PRD Creation

  1. Use this documentation as context input
  2. Reference docs/architecture.md for technical constraints
  3. Consider existing patterns and integrations
  4. Leverage comprehensive model documentation

Contact & Support

  • Repository: github.com/salthq/flowcode
  • Branch Strategy: Main development on develop
  • Environment Setup: Contact team lead for credentials