erxes

Achieving growth and unity within your company is possible with erxes, because it is:

• 100% free & sustainable: erxes offers a sustainable business model in which both developers and users win. It is the source available software, but even better.
• 100% customizable: Our plugin-based architecture provides unlimited customization and lets you meet all your needs, no matter how specific they are.
• 100% privacy: We've designed the erxes platform to retain complete control over your company's sensitive data with no third-party monitoring.
• 100% in control: You can build any experience you want, where all the channels your business operates on are connected and integrated.

---

What does erxes mean? How do you pronounce it?

erxes (pronounced 'erk-sis') is a Mongolian word meaning “galaxy”. A galaxy is a system of stars, stellar remnants, interstellar gas, dust, and dark matter bound together by gravity. The word is derived from the Greek galaxias (γαλαξίας), literally 'milky', a reference to the Milky Way galaxy that contains the Solar System. It is branded as “erxes” with all lowercase letters.

erxes - Improving everyday experiences can significantly enhance the quality of life. These small, incremental improvements can lead to substantial benefits and better living. Better living and happier people will have a contagious effect on everything they touch, eventually improving the universe.

What is erxes?

erxes is a secure, self-hosted, and scalable source available experience management infrastructure that enables SaaS providers and digital marketing agencies/developers to create unique experiences that work for all types of business.

erxes Core & Plugins

erxes is composed of 2 main components: Core & Plugins

Core: It contains the core five modules which goes with all plugins - My inbox, Contacts, Products, Segments, Automation, Documents

Plugins: erxes comes with a set of plugins that allow you to create unique business experiences. Below is a list of some plugins you can choose from our marketplace after you’ve finished installing erxes XOS:

• erxes | Frontline - Frontline powers your customer-facing teams in one place. Omnichannel conversations, tickets, tasks - all seamless.
• erxes | Operation – Keep projects on track with tasks, team resources, and cycle management in one workspace.
• erxes | Sales – Turn regular visitors into qualified leads by capturing them with a customizable landing page, forms, pop-up, or embed placements.
• erxes | Content - Publish anywhere with headless website, corporate sites, e-commerce, scheduling, knowledge base, and help center tools.
• erxes | Accounting – Simplify finances with accounting and salary management built into your workflow.
• erxes | Tourism – Run tours and properties seamlessly with booking and management systems in one place.
• erxes | Property – Oversee real estate with stacking plans, financing & leasing, asset management, community, and investment platforms.
• erxes | Team – Empower people with directories, time clocks, chat, updates, training, and rewards.
• erxes | Finance – Power your bank and non-banking organization with e-banking, mobile apps, core banking, and scoring systems and many more.

Architecture Overview

erxes is built as an Nx-powered monorepo with a modern microservices architecture:

• Backend: GraphQL Federation + tRPC microservices (Node.js, TypeScript, MongoDB, Redis, BullMQ)
• Frontend: Module Federation micro-frontends (React 18, Rspack, TailwindCSS)
• Apps: Standalone applications (Next.js customer portal, POS client, widgets)

┌─────────────────────────────────────────┐
│    API Gateway (Port 4000)              │
│    Apollo Router + Service Discovery     │
└─────────────────────────────────────────┘
              │
    ┌─────────┼─────────┐
    ▼         ▼         ▼
┌─────────┐ ┌──────┐ ┌──────┐
│Core API │ │Plugin│ │Plugin│
│  (3300) │ │ APIs │ │ APIs │
└─────────┘ └──────┘ └──────┘

Quick Start

Run erxes with one command

Try erxes on your computer or a server with Docker. No source code or Node.js needed:

curl -fsSL https://raw.githubusercontent.com/erxes/erxes/main/scripts/install.sh | bash

Pick the plugins to start with, then open http://localhost:3000. On a server, use a domain that points to it and HTTPS is set up automatically:

curl -fsSL https://raw.githubusercontent.com/erxes/erxes/main/scripts/install.sh | bash -s -- --domain crm.example.com --plugins sales,frontline

Run the same command again to upgrade or change plugins. For every option, end the command with bash -s -- --help.

Develop erxes

Prerequisites

• Node.js 18+
• pnpm ≥ 8 (required)
• MongoDB 27017
• Redis 6379

Installation

# Clone the repository
git clone https://github.com/erxes/erxes.git
cd erxes

# Install dependencies (must use pnpm)
pnpm install

# Set up environment variables
cp .env.example .env
# Edit .env and configure MONGO_URL, REDIS_HOST, etc.

# Start core services (Gateway + Core API)
pnpm dev:core-api

# Or start all APIs
pnpm dev:apis

# Start all UI plugins (in another terminal)
pnpm dev:uis

Access the application at http://localhost:3001

This is the beginning of the README. Read the rest at the original. Read the full README ↗