Install the development environment

Requirements

OS

Ubuntu 23.04 or later is recommended, but any Linux distribution should work.

It has also been tested on Windows but it requires more configuration (see below).

Software

ProxyHerd requires:

• Node.js: 20.0.0 or later;
• Java: 8 or later;
• Python: 3.6 or later;
• Gitleaks

Get the repository

Clone the repository:

git clone git@github.com:proxyherd/proxyherd.git

cd proxyherd

Install dependencies

Platform specific: Windows

For Windows development, make sure to install the following dependencies before proceeding with the Node.js dependencies installation:

npm install --save-dev @nx/nx-win32-x64-msvc @rollup/rollup-win32-x64-msvc

Platform specific: MacOS

For MacOS development, make sure to install the following dependencies before proceeding with the Node.js dependencies installation:

npm install --save-dev @nx/nx-darwin-arm64 @rollup/rollup-darwin-arm64

Node.js dependencies

Install Node.js dependencies:

npm install

Test configuration

The test files in packages/backend/test/src/assets (storage-file.env, storage-memory.env, storage-distributed.env) run the language samples with python3 and java taken from your PATH. The Python sample needs the requests package:

python3 -m pip install requests

To use other executables, set PYTHON and JAVA in your shell before running the tests; variables that already exist are not overwritten by the env file.

Build the project

npm run build

Run all tests

The file storage-file.env contains the variables to run the tests.

Before running the tests, you need to set the environment variable DOTENV_FILE to the path of the file storage-file.env:

export DOTENV_FILE=packages/backend/test/src/assets/storage-file.env

On Windows, replace export by set.

TIP

You can replace storage-file.env by storage-memory.env or storage-distributed.env to test other storage.

Then, run the tests:

npm run test

Run the linter

npm run lint

Start the development environment

In a first terminal, run the backend:

export COMMANDER_PORT=8889
export AUTH_LOCAL_USERNAME=admin
export AUTH_LOCAL_PASSWORD=password
export BACKEND_JWT_SECRET=secret1
export FRONTEND_JWT_SECRET=secret2

npm run start:backend-app

On Windows, replace export by set.

---

In a second terminal, run the frontend:

npm run start:frontend-app