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:
Prepare the environment
Create a folder for erxes
Important
Make sure you are inside the erxes folder before proceeding with the installation steps. Being in the correct directory is crucial for the setup process to work properly.
Setup Database
Install MongoDB
Follow the instructions in the MongoDB documentation to install MongoDB on your system.
Install Redis
Follow the instructions in the Redis documentation to install Redis on your system.
Setup erxes
Clone the repository
Copy the environment variables
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.
Install dependencies
Start erxes
Run the frontend
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
Introduction
Get started with erxes and learn the basics
Self-Hosting
Learn how to deploy erxes on your own server with detailed instructions for Ubuntu/CentOS, including server requirements and configuration.
