blob: 65052c5fe574879fb2d51c53a653bc9d85eccbdd (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
## Setting up development environment
### Installing dependencies
The minimum requirements are:
- GNU Bash
- [GNU Coreutils](https://www.gnu.org/software/coreutils/)
- Git
- Node.js (version 16 and above)
To install the project dependencies, run
```sh
# install dependencies
npm install
# install linting and building tools
npm install -g rollup standard
```
## Style guidelines
We use [StandardJS](https://standardjs.com/) with pre-defined ESLint rules to ensure a consistent coding style and catch potential bugs. For checking lint, run
```
npm run lint
```
## Linking Package
```sh
# 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
```sh
npm run addon
```
1. Then Firefox Browser, go to `about:debugging` page. Press `This Firefox` for extension page
1. Press `Load Temporary Add-on...`, then select `manifest.json` in `addon/`
|
