aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJordan Bracco <href@random.sh>2021-08-06 15:55:35 +0200
committerJordan Bracco <href@random.sh>2021-08-06 15:55:35 +0200
commitfd639a6f74d3a2c4cdcc18f5191c101cd41f289b (patch)
tree70697bb7c165197eefdeb60f42fbb71045c8ca59 /README.md
parentNew rebar app (diff)
Kratos flows
Diffstat (limited to '')
-rw-r--r--README.md18
1 files changed, 14 insertions, 4 deletions
diff --git a/README.md b/README.md
index 4f1ea63..4c201d3 100644
--- a/README.md
+++ b/README.md
@@ -3,11 +3,21 @@ styx
Ory Kratos/Hydra Lightweight erlang frontend.
-Can supervise external `kratos` and `hydra` processes directly.
+Made to run on your main top domain. See `config/nginx.conf` for locations.
+Can supervise external `kratos` and `hydra` processes directly (especially useful for development).
+## Getting Started
-Build
------
+Dependencies:
- $ rebar3 compile
+ * NodeJS & NPM (development only, only to modify css/js)
+ * Kratos and Hydra
+ * Erlang, Rebar3
+
+ rebar3 get-deps
+ npm --prefix assets install
+
+Build:
+
+ rebar3 compile && npm --prefix assets deploy