Developing erxes

This document describes how to set up your development environment to develop and test Erxes. It also explains the basic mechanics of using git, node, and yarn.

See the contribution guidelines if you'd like to contribute to erxes.

Prerequisite Software

Before you can develop and test erxes, you must install and configure the following products on your development machine:

Getting the Sources and running locally

  1. Login to your GitHub account or create one by following the instructions given here.

  2. Configure your ssh key here.

  3. Run Erxes backend.

# Clone your GitHub repository:
git clone [email protected]:erxes/erxes-api.git
# Go to the erxes directory:
cd erxes-api
# Copy preconfigured environment variables:
cp .env.sample .env
# Install dependencies (package.json)
yarn install
# Create admin user & save the returned password
yarn initProject
# Load sample data
yarn loadInitialData
# Run
yarn dev
  1. Run Erxes frontend.
# Clone your GitHub repository:
git clone [email protected]:erxes/erxes.git
# Go to the erxes directory:
cd erxes
#Go to the ui folder
cd ui/
# Copy preconfigured environment variables:
cp .env.sample .env
# Install dependencies (package.json)
yarn install
# Run
yarn start

Checkout running website

Visit http://localhost:3000 and login using following credentials

password: the password generated during initProject
Last updated on by Batnasan Byambasuren