aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 25f9d9813db7b26a33d77769bad8d9cd3e98124b (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
# Junction

Connect people through any URL

## Server

### Environment variables

* `JUNCTION_PORT`: This sets the port in which the app will be listening

### Running for development

The project uses docker for easier local development.

1. Create a `.env` file in the root
2. Run `make run` to start the local dev server

### Building for production

Run `make build`. This will create and tag the image.

### Publishing image

Run `make publish`. This will push the image to docker hub.

## Extension

First, make sure to build the plugin. From the extension's root you can call:

```
$ yarn install && yarn build
```

### Testing on Firefox

In order to test on firefox, first go to `about:debugging`, then click
on the `This Firefox` option. Then click on `Load Temporary Add-On` and
point the browser to the `extension/manifest.json` file.

This will enable the extension and will allow you to use the inspector to debug.

### Testing on Chrome

In order to test on chrome, first go to `chrome://extensions/`. Make sure
`Developer mode` is enabled. Then click `Load Unpacked` and point the browser
to the `extension` directory.