DEVELOPING.md

Setting up development environment

Installing dependencies

The minimum requirements are:

• GNU Bash
• GNU Coreutils
• Git
• Node.js (version 16 and above)

To install the project dependencies, run

# install dependencies
npm install

# install dependencies for modules
npm install --dir node_modules/plain-modal
npm install --dir node_modules/plain-draggable

# install linting and building tools
npm install -g rollup standard

Style guidelines

We use StandardJS with pre-defined ESLint rules to ensure a consistent coding style and catch potential bugs. For checking lint, run

npm run lint

Linking Package

# without code minified
npm run build

# with code minified
PRODUCTION=true npm build

Firefox Addon

1. To build addon(after dist/ is generated from npm run build), run

npm run addon

1. Then Firefox Browser, go to about:debugging page. Press This Firefox for extension page

2. Press Load Temporary Add-on..., then select manifest.json in addon/