aboutsummaryrefslogtreecommitdiffhomepage
path: root/DEVELOPING.md
diff options
context:
space:
mode:
Diffstat (limited to 'DEVELOPING.md')
-rw-r--r--DEVELOPING.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/DEVELOPING.md b/DEVELOPING.md
new file mode 100644
index 0000000..687e389
--- /dev/null
+++ b/DEVELOPING.md
@@ -0,0 +1,51 @@
1## Setting up development environment
2
3### Installing dependencies
4
5The minimum requirements are:
6- GNU Bash
7- [GNU Coreutils](https://www.gnu.org/software/coreutils/)
8- Git
9- Node.js (version 16 and above)
10
11To install the project dependencies run
12
13```sh
14# install dependencies
15npm install
16
17# install rollup or use npx
18npm install -g rollup standard
19```
20
21
22## Style guidelines
23
24We use [StandardJS](https://standardjs.com/) with pre-defined ESLint rules to ensure a consistent coding style and catch potential bugs. For checking lint, run
25
26```
27npm run lint
28```
29
30
31## Linking Package
32
33```sh
34# without code minified
35npm build
36
37# with code minified
38PRODUCTION=true npm build
39```
40
41## Firefox Addon
42
431. To build addon(after `dist/` is generated from `npm build`), run
44
45```sh
46npm run addon
47```
48
492. Then go to `about:debugging` page in Firfox Browser, then press `This Firefox` for extension page
50
513. Press `Load Temporary Add-on...`, then select `manifest.json` in `addon/`