From 1c8964a122fe29e60ae88fc61bbb8b9f20b59202 Mon Sep 17 00:00:00 2001 From: Goose Date: Sat, 26 Sep 2026 08:07:24 +0000 Subject: [PATCH] docs: add project README.md documenting architecture, features, and setup --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2b806b8 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# OpenForce — Salesforce Recreation in Django & Vue 3 + +OpenForce is an enterprise-grade Customer Relationship Management (CRM) platform recreating the core capabilities of Salesforce using Python/Django 4.2 REST Framework on the backend and Vue 3 + TailwindCSS + Pinia on the frontend. + +## Key Features + +1. **Standard CRM Tracking**: + - **Leads**: Complete lifecycle tracking with atomic lead conversion (`Lead -> Account + Contact + Opportunity`). + - **Accounts**: Hierarchical organization tracking (parent-child relationships). + - **Contacts**: Person records mapped to accounts with full contact details. + - **Opportunities**: Pipeline stage management with automatic expected revenue calculations (`Amount * Probability%`). + - **Activities & Tasks**: Polymorphic task logging across Leads, Contacts, and Accounts with completion tracking. + +2. **Dynamic Custom Objects Metamodel**: + - Create custom schemas (`CustomObjectDefinition` + `CustomFieldDefinition`) on the fly like Salesforce `__c` objects. + - Dynamic JSONB storage with PostgreSQL GIN index (`idx_custom_record_data_gin`). + - Dynamic Draft-07 JSONSchema validation on record creation and partial `PATCH` updates. + - RESTful dynamic endpoints: `/api/custom//`. + +3. **Visual Flow Builder (Automation DAG Engine)**: + - Visual workflow editor powered by `@vue-flow/core`. + - Kahn's algorithm topological sorting with cycle detection and dangling edge prevention. + - Conditional branch evaluation and execution tracing with idempotency keys. + +4. **Outreach & Email Campaigns**: + - Safe merge-tag template engine (`{{ first_name }}`, `{{ company }}`). + - Campaign batch dispatching with 1x1 transparent tracking pixel injection. + +## Running Locally + +### Backend (Django) +```bash +python manage.py migrate +python manage.py collectstatic --noinput +python manage.py runserver 0.0.0.0:8000 +``` + +### Running Tests +```bash +pytest --cov=crm_core --cov=custom_objects --cov=workflows --cov=outreach +```