## Overview

ORIGEN CRM System is a full-featured customer relationship and business management
platform for small and medium businesses. It combines CRM, sales, project
management, finance, reporting and communications in one self-hosted application,
delivered as a fully isolated instance ("tenant") per customer.

Every tenant runs in its own containerized environment with its own database,
files and domain — no data is shared between customers.

## Core modules

### Customers & Contacts
- Customer records with companies, primary contacts, avatars and addresses
- Separate Contacts directory linked to customers
- Full-text customer search and filtering in the dashboard

### Sales
- **Invoices** — line items, taxes, statuses, payments against invoices, PDF output
- **Estimates** and **Proposals** — quote documents with their own lifecycle
- **Payments** — payment records with multiple payment modes
- **Credit Notes** — credit documents linked to invoicing
- **Items** — reusable products/services with prices and taxes

### Leads pipeline
- Lead records with statuses and sources (both configurable)
- Lead→customer conversion path
- Lead reporting and conversion metrics

### Projects & Tasks
- Projects with tasks, progress tracking and a calendar view
- Timesheet overview report
- Goals tracking

### Expenses
- Expense records by category, tied into finance reporting
- Expenses-vs-income reporting

### Utilities
- **Database Backup** — create, download, schedule (with retention) and restore backups of the SQLite database; restoring writes a safety copy first
- **Media** — file/avatar/logo library
- **Bulk PDF Export** — export documents in bulk
- **e-Invoice Export** — structured e-invoice export
- **CSV Export** — data export
- **Activity Log** — audit trail of user actions

### Reports
- Sales, Expenses, Expenses vs Income, Leads (conversion), Timesheet Overview

### Communications
- **Email** — SMTP settings plus configurable email templates
- **SMS** — provider-agnostic HTTP integration (works with providers such as
seven.io), SMS activity log, manual "Send SMS Reminder" per invoice, and
automatic reminders: on the invoice due date and every 7 days while overdue
(toggleable, deduplicated so a customer is never texted twice in one day)

## Administration & configuration

- **Staff & Departments** — team structure
- **Roles** — granular permissions per module (view / create / edit / delete)
- **Finance setup** — payment modes, currencies, taxes, expense categories
- **Custom Fields** — extend records without code changes
- **Menu Setup & Theme Style** — customise navigation and look & feel per tenant
- **Modules** — manage application modules
- **GDPR** — data protection settings
- **Settings / Help** — system settings and help pages

## Security

- JWT authentication with short-lived access tokens (15 min) and refresh
tokens (7 days); bcrypt password hashing
- Role-based access control enforced on every API endpoint
- Per-tenant isolation: separate database, uploads, secrets and containers
- API documentation (Swagger UI) served at `/api/docs` on the API

## Technology

| Layer | Stack |
|-----------|-------|
| Backend | NestJS + Prisma (SQLite by default, PostgreSQL-ready), REST API, Swagger |
| Frontend | React 18 + TypeScript + Vite + MUI v6 + TanStack Query |
| Runtime | Node.js 24 (Docker images `node:24`) |
| Database | SQLite (single-file, in-app backup/restore) — optional PostgreSQL for development |
| Storage | Local `data/` + `uploads/` volumes per tenant |
| Packaging | Docker images (`api`, `web`) + Caddy reverse proxy |

## Deployment model

Each customer gets one Debian LXC (Proxmox) running a Docker Compose stack: