Skip to content

About

Full control over clients, deals, automation, and integrations. Built with a custom async ORM (DotORM) and strong emphasis on modularity so modules can be enabled/disabled or extracted as microservices.

Resources

Stars

7 stars

Watchers

0 watching

Forks

Repository files navigation

FARA CRM

Modular CRM system built on FastAPI + React with a custom ORM (DotORM), real-time chat via WebSocket, and integrations with external messengers.

🌐 Official site: faracrm.com 🕹️ Demo: demo.faracrm.com 📖 Full documentation: docs.faracrm.com


Stack

Layer Technologies
Backend Python 3.12+, FastAPI, asyncpg, PostgreSQL
ORM DotORM (in-house async ORM)
Frontend React 18, TypeScript, Mantine UI v8, Redux Toolkit
Real-time WebSocket + PostgreSQL LISTEN/NOTIFY (redis optional)
Integrations Telegram, WhatsApp, Avito, VK, Maks Email (IMAP/SMTP)
Telephony Asterisk, Sipuni, Megafon, Mts, Beeline

Quick start

Docker

It is used for running locally without dependencies and for demonstrating capabilities; there is also a production build, but that is a separate script.

docker compose -f docker-compose.dev.yml up --build

Local development

Used by developers for modifications; includes debug mode and other useful IDE features.

Backend:

# F5 if you use VS Code
# or:
pip install -r requirements.txt
cp .env.sample .env
uvicorn backend.main:app --host 0.0.0.0 --port 8090

Frontend:

cd frontend
yarn install
yarn dev

Production

Check the documentation, specifically the deployment guide section.

Project layout

fara/
├── backend/
│   ├── main.py                  # FastAPI entry point
│   ├── main_cron.py             # Cron jobs
│   ├── project_setup.py         # Models, Apps, Settings
│   └── base/
│       ├── system/              # Core: ORM, auth, services
│       │   ├── dotorm/          # DotORM — async ORM
│       │   ├── dotorm_crud_auto/# Auto-generated CRUD API
│       │   ├── core/            # Environment, Service
│       │   └── schemas/
│       └── crm/                 # Business modules
│           ├── chat/            # Chat + WebSocket
│           ├── security/        # ACL, sessions, roles
│           ├── users/
│           ├── leads/
│           ├── sales/
│           ├── partners/
│           ├── tasks/
│           └── ...
├── frontend/
│   └── src/
│       ├── services/api/        # RTK Query API
│       ├── store/               # Redux store
│       ├── fara_chat/           # Chat module
│       └── ...
├── tests/
├── docs/                        # MkDocs documentation
└── docker-compose.yml

Documentation

The documentation lives in docs/ and is built with MkDocs Material.

Section Description
Backend Architecture, DotORM, modules, API
Frontend React app, state management
Guides New module, WebSocket, tests

Demo

🌐 demo.faracrm.com

License

FARA CRM License v1.0

About

Full control over clients, deals, automation, and integrations. Built with a custom async ORM (DotORM) and strong emphasis on modularity so modules can be enabled/disabled or extracted as microservices.

Resources

Stars

7 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages