X-Git-Url: https://git.r.bdr.sh/rbdr/junction/blobdiff_plain/ac259c8645783dcb92fc0eafff166769f5216aa9..refs/heads/rbdr-dockerize:/README.md diff --git a/README.md b/README.md index 9e420d3..25f9d98 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,35 @@ 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 @@ -11,3 +38,9 @@ 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.