Skip to content

csbuddypro-sys/csbuddypro

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

256 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CSBuddyPro

CSBuddyPro is an open-source, self-hostable Customer Success Operating System designed for SaaS teams. It is evolving into a modular platform inspired by Odoo-style extensibility: core product + installable modules + optional plugins.

Screenshots

Placeholder: add product screenshots in docs/assets/.

Features

  • Account and lifecycle management
  • Health scoring and automation playbooks
  • Onboarding, QBR, and renewals workflows
  • Plugin-ready integrations (Slack, HubSpot, Zapier, Webhooks)
  • Docker-first deployment for local and production environments

Architecture Overview

/frontend   -> frontend boundary (React app)
/backend    -> backend runtime boundary (Express API)
/docker     -> shared runtime/container assets
/docs       -> setup, architecture, API, deployment docs
/modules    -> domain modules (installable)
/plugins    -> integration plugins (toggleable)

The platform uses registry-based extension manifests:

  • modules/registry.json
  • plugins/registry.json
  • dynamic loader: src/platform/extensionRegistry.ts

Quick Start

git clone <your-fork-url>
cd csbuddypro
cp .env.example .env
docker compose up --build

App: http://localhost:8080
API: http://localhost:10000

Docker Install

  • Uses one command startup: docker compose up
  • Includes isolated services (frontend, backend, db)
  • Persistent volumes: postgres_data, backend_uploads
  • Restart policy: unless-stopped

See docs/docker-setup.md.

Local Development

cp .env.example .env
npm ci
npm run dev

See docs/local-development.md.

Master Data Management

Structured dropdown values are managed centrally from /settings/master-data and exposed through /api/master-data/*. See docs/master-data-management.md.

Administration, Portal, Knowledge Base & API Transformation

The Admin Panel is the central configuration hub for users, lifecycle/health/workflow settings, dropdowns, Knowledge Base structure, integrations, portal configuration, and AI settings. See docs/admin-portal-api-transformation.md.

Customer Success Status Framework

Lifecycle, health, onboarding, and renewal statuses are centralized through /api/status-framework with defaults and Field Config overrides. See docs/status-framework.md.

Module System

Modules live in /modules/* and include metadata, versioning, permissions, migrations, backend/frontend contract placeholders.

See docs/module-development.md. Phase 2/3 scaffolds are also documented in docs/api-management.md and docs/knowledge-base-modernization.md.

Plugin System

Plugins live in /plugins/* and can be enabled/disabled independently via registry + environment flags.

See docs/plugin-development.md.

Deployment Instructions

  • Docker / VPS / Coolify: docs/deployment.md
  • Render: render.yaml and docs/deploy-render.md
  • Railway: railway.json and docs/deploy-railway.md

Contributing

Read CONTRIBUTING.md and docs/contribution-guide.md before opening a PR.

Roadmap

See ROADMAP.md for phased delivery (core stabilization, marketplace, automation/AI, enterprise scale).

License

Licensed under GNU Affero General Public License v3.0 (AGPL-3.0-or-later).
If you run a modified network-hosted version, you must provide source code of modifications to users as required by AGPL.

Releases

No releases published

Packages

 
 
 

Contributors

Languages