aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRuben Beltran del Rio <ruben@unlimited.pizza>2020-10-07 22:58:07 +0200
committerRuben Beltran del Rio <ruben@unlimited.pizza>2020-10-07 22:58:07 +0200
commite50e067d034493b837bb7c8773d982c6468299a3 (patch)
treef84c37dd04c2f9bc21b8b3f2a2e52858ee5104f6
parent43c5f0ddbc5ab13568084c594f3175204617a8aa (diff)
Update README
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
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: