From e50e067d034493b837bb7c8773d982c6468299a3 Mon Sep 17 00:00:00 2001 From: Ruben Beltran del Rio Date: Wed, 7 Oct 2020 22:58:07 +0200 Subject: Update README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index ce413b1..25f9d98 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,27 @@ 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: -- cgit