This document describes how to set up your development environment to develop and test erxes. It also explains the basic mechanics of using
See the contribution guidelines if you'd like to contribute to erxes.
Before you can develop and test erxes, you must install and configure the following products on your development machine:
- Git and/or the GitHub app (for Mac or Windows); GitHub's Guide to Installing Git is a good source of information.
- Node.js, v10.x LTS which is used to run a development web server, run tests, and generate distributable files.
- Yarn which is used to install dependencies.
- MongoDB version 3.6.x
- Redis version 3.x +
Getting the Sources
Fork and clone the erxes repository:
Login to your GitHub account or create one by following the instructions given here.
Fork the relevant erxes repository.
Clone your fork of the erxes repository and define an upstream remote pointing back to the erxes repository that you forked in the first place.
# Clone your GitHub repository: git clone [email protected]:<github username>/erxes.git # Go to the erxes directory: cd erxes # Add the main erxes repository as an upstream remote to your repository: git remote add upstream https://github.com/erxes/erxes.git
Installing NPM Modules
# Install erxes project dependencies (package.json) yarn install
Running Tests Locally