The idea is to provide the user a quick way to discover and install plugins via the plugin store.
how to install Node.js 18.16 with nvm
$ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
$ wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
$ export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"\n[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
$ command -v nvm
how to install Node.js 18.16 with nvm
$ nvm install 18.16.0
run the server
$ npm start
lint
$ npm run lint
fix the linting
$ npm run fix
run tests and see code coverage
$ npm test
If you want to retrieve plugins via a local self hosted server or via a docker server image you first need to add plugins.
python3 ./build.py --plugin <path-to-plugin> --arch <architecture-target>
$ curl -X GET http://localhost:3000/?arch=desktop
$ curl -X GET http://localhost:3000/details/AudioFilter
$ curl -X GET http://localhost:3000/download/WaterMark.jpl
We have a set of ESLint rules that define clear syntax rules (/.eslintrc.json). You will need the following tools:
We will not accept patches introducing non-ESLint-compliant code.
To install Docker please read this manual: https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository
Reminder: To successfully run the docker server image and retrieve plugins your first need to add plugins. To do so, please follow the instructions in the section "Add plugin in development environnement".
Build a docker image:
docker build -t server-image --target server .
Run the docker container:
docker run -p 3000:3000 -ti server-image
To stop the container do CTRL + C in the terminal.
Build the test image:
docker build -t test-image --target test .
Run the test image:
docker run test-image
Build the lint image:
docker build -t lint-image --target lint .
Run the lint image:
docker run lint-image