Company Manager Documentation

Welcome to the comprehensive documentation for Company Manager, a sophisticated multi-tenant business management platform built as a modern monorepo with multiple applications, services, and packages.

🏗️ Architecture Overview

Company Manager is a comprehensive business management solution featuring:

• Multi-tenant architecture with site-level isolation
• Multiple applications (web, mobile, desktop, extensions)
• Go-based microservices for high-performance operations
• Modern frontend stack with React, Next.js, and TypeScript
• Robust data layer with Prisma and PostgreSQL
• Queue management with Redis and Asynq
• Real-time monitoring and dashboard systems

🚀 Quick Start

Prerequisites

• Node.js 18.17.0+
• Bun (package manager)
• Docker & Docker Compose
• Go 1.21+
• PostgreSQL
• Redis

Installation

# Clone the repository
git clone <repository-url>
cd company-manager-new

# Install dependencies
bun install

# Start infrastructure services
bun run infra:start

# Start the main application
bun run dev:app

📱 Applications

Web Applications

• Main App - Primary web application (apps/app)

• Documentation - This documentation site (apps/docs)

Desktop Applications

• Desktop App - Cross-platform desktop application
• Desktop Dev - Development version of desktop app

Mobile Applications

• Mobile App - React Native mobile application

Browser Extensions

• Chrome Extension - Production Chrome extension
• Chrome Extension Dev - Development Chrome extension
• VSCode Extension - Visual Studio Code extension

Go Services

• Queue Manager Go - Queue management service
• Asynq Job Queue - Async job processing
• Infrastructure Dashboard - System monitoring dashboard

📦 Packages

Core Packages

• Database - Prisma schema and database utilities
• Common - Shared utilities and types
• Utils - Common utility functions
• TRPC - Type-safe API layer

UI Packages

• UI Components - Shared UI components with ShadCN
• Plate UI - Rich text editor components
• Mobile Components - React Native components
• UI Mobile - Mobile-specific UI components

Development Packages

• CLI - Command-line interface tools
• MCP Server - Model Context Protocol server
• Browser Testing - Automated testing utilities
• Tests - Shared testing utilities

Configuration Packages

• TypeScript Config - Shared TypeScript configurations
• ESLint Config - Shared linting rules
• Expo Config - React Native Expo configuration

Queue & Task Management

• Queue Manager - Task queue management
• Queue Task - Task definitions and handlers
• Proto Go - Protocol buffer definitions

💼 Business Features

Core Business Logic

• Multi-Tenant Management - Tenant and site management
• User Management - User roles and permissions
• Client Management - Customer relationship management
• Order Management - Order processing and fulfillment
• Invoice Management - Billing and invoicing
• Product Management - Inventory and catalog management
• Vendor Management - Supplier relationship management

Advanced Features

• Contact Management - Contact and communication tracking
• Dashboard & Analytics - Business intelligence and reporting
• Payment Processing - Payment gateway integrations
• Data Synchronization - External system integration

🛠️ Development

Getting Started

• Development Environment Setup
• Project Structure
• Development Workflow
• Code Standards

Technical Guides

• Database Design
• API Development
• Frontend Development
• State Management
• Testing Strategy

Infrastructure

• Docker Setup
• Queue System
• Monitoring & Logging
• Performance Optimization

🔌 Integrations

External Systems

• PrestaShop Integration
• WordPress/WooCommerce
• Axelor Integration
• Payment Gateways

API Integrations

• Webhook System
• Third-party APIs
• Data Import/Export

🚀 Deployment

Infrastructure

• Production Setup
• Kubernetes Deployment
• Docker Deployment
• CI/CD Pipeline

Configuration

• Environment Configuration
• Database Migration
• Security Configuration
• Monitoring Setup

📊 UML Documentation

Comprehensive business process diagrams organized by domain:

Domain Diagrams

• UML Documentation Hub - Central navigation for all diagrams
• E-Commerce - Orders, payments, shipping, inventory
• Subscriptions - Lifecycle, billing cycles, renewals
• CRM - Leads, opportunities, client onboarding
• CMS - Content workflow, magazine production
• Communications - Email automation, delivery tracking
• Workflows - Execution engine, node types, job processing
• Field Service - Interventions, equipment lifecycle
• Events - Bookings, availability management
• POS - Transactions, kitchen display, table management
• Platform - Tenant isolation, permissions, service registry

📚 Reference

API Documentation

• REST API Reference
• TRPC API Reference
• GraphQL Schema
• Webhook Events

Data Models

• Database Schema
• Entity Relationships
• Data Validation

Configuration

• Application Configuration
• Environment Variables
• Feature Flags

🆘 Support & Troubleshooting

Common Issues

• FAQ
• Troubleshooting Guide
• Error Codes
• Performance Issues

Best Practices

• Development Best Practices
• Security Guidelines
• Code Review Guidelines

Maintenance

• Update Procedures
• Backup & Recovery
• Database Maintenance

📈 Monitoring & Analytics

System Monitoring

• Application Metrics
• Infrastructure Monitoring
• Log Management
• Error Tracking

Business Analytics

• Business Intelligence
• User Analytics
• Performance Analytics

Contributing

This documentation is continuously updated. For contributions, please see our contribution guidelines.

License

Company Manager is proprietary software. All rights reserved.

Last updated: June 2025