Local Setup

Learn how to set up erxes on your local machine

Prerequisites

Before you can install and use erxes, make sure you install the following on your computer:

• Git
• Node.js v20 or higher
• pnpm
• nx
• nvm

Prepare the environment

1

Create a folder for erxes

Setup Database

Setup erxes

1

Clone the repository

SSH (recommended)HTTPS

2

Copy the environment variables

3

Configure the environment variables

Important

If You are not using plugins, you can remove the ENABLED_PLUGINS line. If ENABLED_PLUGINS is null value it might break the setup process.

4

Install dependencies

Start erxes

1

Run the frontend

2

Run the backend

Access erxes Services

Once you've started both the frontend and backend services, you can access them at the following URLs:

Frontend

erxes frontend is available at http://localhost:3001

Backend Services

• erxes gateway is available at http://localhost:4000
• erxes graphql federation server is available at http://localhost:4000/graphql
• erxes core service is available at http://localhost:3300