Skip to main content

Get Started

Welcome to the CallPilot.ai internal documentation.
This space is designed for the technical team (backend, frontend, DevOps, data, QA, architecture, and support).

It includes detailed references on how the system is built, how we deploy, how we integrate, how we debug, and how we evolve the platform.

⚠️ Important: All content here is private and must not be shared with clients without prior review.

🧱 What you’ll find here​

The Internal Docs folder is divided into the following areas:

1. General Architecture​

A complete description of how CallPilot works at a technical level:

  • Main components
  • Backend services
  • Web frontend
  • Communication flows
  • Event-driven architecture
  • External integrations
  • Multi-tenant & security
  • Diagrams (Mermaid) and module breakdowns

👉 architecture/

2. Infrastructure​

Documentation of the platform on Azure (or the defined provider):

  • Container Apps / Kubernetes / App Services
  • Storage (Blob)
  • Databases (PostgreSQL, Mongo)
  • Virtual Networks & Firewall / WAF
  • Observability (Log Analytics, Monitoring, Alerts)
  • CI/CD pipelines
  • Versioning / environments (DEV, UAT, PROD)
  • Secret management (KeyVault)

👉 infrastructure/

3. Backend​

Complete guide for working with backend microservices:

  • Monorepo structure / separated repos
  • Design patterns (Clean Architecture, modularization)
  • FastAPI / Node.js / Workers (adjust to actual stack)
  • DB connections
  • Async jobs and queues
  • Versioning rules
  • Testing
  • How to add an endpoint
  • Best practices
  • Logging standards

👉 backend/

4. Frontend​

Documentation for the web frontend:

  • Get Started (install, run, conventions)
  • Environment variables
  • Local development
  • Folder structure
  • Recommended patterns (hooks, features, API clients)
  • Testing with Vitest
  • Frontend CI/CD

👉 frontend/

5. Integrations​

Internal documentation on how CallPilot consumes external systems:

  • Diamond API
  • Raters / ITC
  • Odoo CRM
  • Internal webhooks
  • Authentication flows
  • Mappings, payloads, and common errors
  • Testing and debugging

👉 integrations/

6. Operational & Support (Ops)​

Internal manuals for:

  • How to perform manual/forced deployments
  • Rollback procedure
  • How to analyze production errors
  • QA checklists
  • Incident playbooks
  • How to read logs
  • Ticket creation & prioritization
  • Internal SOPs

👉 ops/

7. Functional Documentation​

Product-level documentation used to confirm expected behavior:

  • Campaigns
  • Channels
  • Assignments
  • Flows / Nodes
  • Settings
  • Permissions
  • Reporting
  • Domain-specific validations & business rules

👉 functional/

8. Code & Standards​

Internal rules:

  • Naming conventions
  • PR structure
  • Formatters & linters
  • Commits (Conventional Commits / trunk-based / gitflow)
  • Branching: dev / main / release
  • Semantic versioning

👉 coding-standards/

🧭 How to navigate Internal Docs​

Here’s the recommended path:

  1. Read General Architecture
    To understand the full system at a visual level.

  2. Set up your local environment

    • Frontend → frontend-local-development.md
    • Backend → backend-local-development.md

  3. Review contribution standards
    So we work aligned from day one.

  4. Explore the section relevant to your role
    Backend / Frontend / Infra / Integrations.

  5. Come back here anytime you have a question
    This folder is the single source of truth.

🛠 Internal tools used​

  • Frontend: React, TypeScript, Vite
  • Backend: FastAPI / Node (depending on microservice)
  • Infra: Azure Container Apps, PostgreSQL, Storage
  • CI/CD: GitHub Actions
  • Logs: Log Analytics
  • Docs: Docusaurus
  • Diagrams: Mermaid
  • QA: Postman, Vitest, Pytest
  • Communication & PM: Jira, Slack, Confluence

📬 Missing something?​

If you think something is missing:

  • Create a PR with a new doc
  • Or open an issue in the internal repo #int