Skip to content

Latest commit

 

History

31 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

DX-OS: Open-Source AI-Native Marketing Operating System

License: Apache-2.0 REUSE status Local Build Security Scanning SBOM Status

Current Status: NOT_READY (Bootstrap Remediation). DX-OS is an independent, sovereign open-source software project licensed under the Apache-2.0 License. It is not Elsa and is not an undisclosed Elsa fork. DX-OS integrates Elsa workflow capabilities as a clean NuGet dependency (Elsa 3.7.1).


1. What is DX-OS?

DX-OS is an open-source, AI-native operating system designed for Small and Medium Enterprises (SMEs) to orchestrate, automate, and govern their marketing workflows, campaign pipelines, customer analytics, and AI agent executions within a sovereign, self-hosted environment.


2. Who is DX-OS For?

  • SMEs & Growth Teams: Organizations seeking enterprise-grade marketing automation without recurrent per-seat vendor fees or cloud lock-in.
  • Engineers & Architects: Developers building complex, event-driven marketing workflows and autonomous AI agents with full code inspection and auditability.
  • Privacy-Conscious Organizations: Enterprises requiring strict data sovereignty where customer data and proprietary campaign strategies never leave their self-hosted infrastructure.

3. What Problem Does It Solve?

Traditional marketing tech stacks suffer from:

  1. SaaS Fragmentation: Marketing data trapped across disparate CRM, email, social, and analytics tools.
  2. Ungoverned AI Agents: Hallucination risks, unmonitored API calls, and unpredictable autonomous agent behaviors.
  3. Vendor Lock-in & Prohibitive Costs: Escalating per-contact and per-seat pricing models.
  4. Data Sovereignty Violations: Customer analytics and PII exported to third-party proprietary clouds.

DX-OS solves this by delivering a unified, self-hosted modular monolith with deterministic workflow execution, governed AI agent boundaries, and end-to-end PostgreSQL persistence.


4. Current Implementation Status

Milestone / Capability Status Description
BR001-R1: Repository Identity & Provenance ACCEPTED Independent DX-OS provenance, Apache-2.0 licensing, clean Git history.
BR001-R2: Foundation & Build Automation ACCEPTED .NET 10 Release compilation, deterministic CPM package locks, zero warnings.
BR001-R3: Quality Gate Engine ACCEPTED 26 automated gates covering format, hygiene, tests, and security scans.
BR001-R4: Runtime Startup & Smoke Orchestration ACCEPTED Docker Compose & .NET Aspire orchestration with PostgreSQL 18.4.
BR001-R5: Testing Suite ACCEPTED Unit tests (xUnit.net v3), ArchUnitNET architecture tests, Testcontainers PostgreSQL integration tests.
BR001-R6: Governance & Architectural Decision Records ACCEPTED 7 ADRs, OpenSpec governance, and machine-readable state tracking.
BR001-R7: Security, Supply Chain & OSS Inventory IMPLEMENTED_LOCALLY / AWAITING_INDEPENDENT_REVIEW Gitleaks secret scanning, Trivy misconfig checks, Syft CycloneDX SBOM, Grype vulnerability scans.
BR001-R8: Clean Clone & Public Audits NOT STARTED Public repository transition, verification badges, and external audits.

5. Architecture Overview

DX-OS is architected as a Modular Monolith adhering to Clean Architecture principles:

               ┌─────────────────────────────────────────────────┐
               │                 DX-OS AppHost                   │
               │         (.NET Aspire / Docker Compose)          │
               └───────────────┬─────────────────┬───────────────┘
                               │                 │
               ┌───────────────▼────────┐ ┌──────▼───────────────┐
               │        DX-OS Api       │ │   PostgreSQL 18.4    │
               │  (ASP.NET Core / Elsa) │ │     (Database)       │
               └───────────────┬────────┘ └──────────────────────┘
                               │
               ┌───────────────▼────────────────┐
               │       DX-OS Application        │
               │  (Use Cases & Orchestration)   │
               └───────┬────────────────┬───────┘
                       │                │
       ┌───────────────▼────────┐ ┌─────▼────────────────────────┐
       │      DX-OS Domain      │ │      DX-OS Workflows         │
       │   (Entities & Rules)   │ │  (Elsa Activity Definitions) │
       └────────────────────────┘ └──────────────┬───────────────┘
                                                 │
                               ┌─────────────────▼───────────────┐
                               │     DX-OS Infrastructure        │
                               │ (EF Core Migrations & Npgsql)   │
                               └─────────────────────────────────┘
  • src/DXOS.Domain: Pure domain models, value objects, and business invariant validations.
  • src/DXOS.Application: Application commands, queries, and business workflow interfaces.
  • src/DXOS.Workflows: Elsa 3.7 workflow definitions, custom marketing activities, and execution graphs.
  • src/DXOS.Infrastructure: PostgreSQL database contexts, EF Core 10 mappings, and data access.
  • src/DXOS.Api: HTTP API controllers, middleware, and Elsa dashboard/server endpoints.
  • src/DXOS.AppHost: .NET Aspire distributed application orchestrator for local and containerized runs.

6. Quick Start (Under 5 Minutes)

Prerequisites

Launching with Docker Compose

# 1. Clone the official repository (GitHub repository name is `open_source`; the project is DX-OS)
git clone https://github.com/ROYCE-8425/open_source.git dx-os
cd dx-os

# 2. Start PostgreSQL and DX-OS Api
docker compose up -d

# 3. Verify health endpoint
curl -f http://localhost:5000/health

The DX-OS API is at http://localhost:8080. PostgreSQL is at localhost:5432 (or POSTGRES_PORT).

Open the operator board (Vietnamese, VND): http://localhost:8080/. Visual rules: docs/design.md. Product board: docs/PRODUCT_BOARD.md.

Lead-to-CPL slice (NOT_READY, no live ads): send X-DXOS-Role and X-DXOS-Actor. Endpoints: POST /campaigns, POST /campaigns/{id}/submit-review, POST /campaigns/{id}/approve, POST /campaigns/{id}/reject, GET /campaigns/{id}, POST /leads/webhook, GET /leads, POST /leads/{id}/claim, GET /dashboard/cpl. DX-OS stops at Lead/CPL and does not close orders.


7. Building from Source

To compile and verify DX-OS locally:

# Restore dependencies with locked CPM packages
dotnet restore --locked-mode

# Build entire solution in Release mode with zero warnings
dotnet build -c Release --no-restore

For comprehensive instructions on dependencies and prerequisites, refer to docs/build-from-source.md.


8. Running Tests & Quality Gates

DX-OS enforces a strict, fail-fast quality gate system. No paid tools or proprietary accounts are required.

Running Test Projects Directly

# Run unit tests (xUnit v3)
dotnet test tests/DXOS.Unit.Tests

# Run architectural boundary tests (ArchUnitNET)
dotnet test tests/DXOS.Architecture.Tests

# Run PostgreSQL integration tests (Testcontainers)
dotnet test tests/DXOS.Integration.Tests

Running the Complete Quality Gate Engine

# Run all 26 foundation, runtime, and security gates
powershell -ExecutionPolicy Bypass -File .\scripts\check.ps1 -Profile Full

9. Third-Party Dependencies & Services

  • Upstream Open-Source Packages:
    • Elsa 3.7.1 (MIT License) - Workflow orchestration engine.
    • Microsoft.EntityFrameworkCore 10.0.10 (MIT License) - Data modeling and persistence.
    • Npgsql.EntityFrameworkCore.PostgreSQL 10.0.3 (PostgreSQL License) - PostgreSQL provider.
    • Aspire.Hosting 13.4.6 (MIT License) - Microservice orchestration.
  • Third-Party Services:
    • All runtime operations function completely independently without mandatory external cloud services.
    • AI model gateways support self-hosted models or optional provider integrations (e.g. Google Gemini, OpenAI) disclosed in docs/THIRD_PARTY_SERVICES.md.

For the full dependency inventory and license breakdown, see OPEN_SOURCE.md and THIRD_PARTY_NOTICES.md.


10. Roadmap

  • Phase 1: Foundation & Identity (Clean modular architecture, CPM locks, Apache-2.0 licensing)
  • Phase 2: Automated Quality Gates (26 automated CI/CD and security gates)
  • Phase 3: Runtime & Testing (Testcontainers PostgreSQL integration, Aspire orchestration)
  • Phase 4: Visual Workflow Studio (Embedded Elsa web dashboard with custom marketing activities)
  • Phase 5: Marketing Connectors (Integrations for Email, Webhooks, CRM, and Social channels)
  • Phase 6: Governed AI Execution Gateway (Policy-bounded LLM agents with prompt logging and audit trails)

See ROADMAP.md for detailed release milestones.


11. Contributing

We welcome contributions from the global open-source community!


12. Security & Vulnerability Reporting

Security is a primary design pillar for DX-OS. All code undergoes automated Gitleaks secret detection, Trivy misconfiguration analysis, and Grype vulnerability scanning.

If you discover a potential security vulnerability, please follow our coordinated disclosure policy detailed in SECURITY.md. Please do not report security vulnerabilities via public GitHub issues.


License

DX-OS is distributed under the terms of the Apache License, Version 2.0. See LICENSE and NOTICE for details.

About

Open-source AI-native operating system for SME marketing workflows, automation, analytics and governed AI agents.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages