git.r.bdr.sh / rbdr / junction / blame
| Commit | Line | Data |
|---|---|---|
| 02bc8bc5 RBR |
1 | # Junction |
| 2 | ||
| 1ed219c8 RBR |
3 | Connect people through any URL |
| 4 | ||
| e50e067d RBR |
5 | ## Server |
| 6 | ||
| 7 | ### Environment variables | |
| 8 | ||
| 9 | * `JUNCTION_PORT`: This sets the port in which the app will be listening | |
| 10 | ||
| 11 | ### Running for development | |
| 12 | ||
| 13 | The project uses docker for easier local development. | |
| 14 | ||
| 15 | 1. Create a `.env` file in the root | |
| 16 | 2. Run `make run` to start the local dev server | |
| 17 | ||
| 18 | ### Building for production | |
| 19 | ||
| 20 | Run `make build`. This will create and tag the image. | |
| 21 | ||
| 22 | ### Publishing image | |
| 23 | ||
| 24 | Run `make publish`. This will push the image to docker hub. | |
| 25 | ||
| 1ed219c8 RBR |
26 | ## Extension |
| 27 | ||
| e3dca99b | 28 | First, make sure to build the plugin. From the extension's root you can call: |
| 29 | ||
| 30 | ``` | |
| 31 | $ yarn install && yarn build | |
| 32 | ``` | |
| 33 | ||
| 1ed219c8 RBR |
34 | ### Testing on Firefox |
| 35 | ||
| 36 | In order to test on firefox, first go to `about:debugging`, then click | |
| 37 | on the `This Firefox` option. Then click on `Load Temporary Add-On` and | |
| 38 | point the browser to the `extension/manifest.json` file. | |
| 39 | ||
| 40 | This will enable the extension and will allow you to use the inspector to debug. | |
| a94a5407 RBR |
41 | |
| 42 | ### Testing on Chrome | |
| 43 | ||
| 44 | In order to test on chrome, first go to `chrome://extensions/`. Make sure | |
| 45 | `Developer mode` is enabled. Then click `Load Unpacked` and point the browser | |
| 46 | to the `extension` directory. |