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
Scrapoxy requires:
Get the repository
Clone the repository:
git clone git@github.com:fabienvauchelles/scrapoxy.git
cd scrapoxy
Install dependencies
For Windows development, ensure the installation of the following dependencies before proceeding:
npm install --save-dev @nx/nx-win32-x64-msvc @rollup/rollup-win32-x64-msvc
Install Node.js dependencies:
npm install
Update test configuration
In the folder packages/backend/test/src/assets
, open the files:
storage-file.env
,storage-memory.env
storage-distributed.env
And update the following values:
PYTHON
: path to Python executableJAVA
: path to Java executable
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