aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8351258..47937cf 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,23 @@ the companies I wrote this for some number of years ago.
Most of the features are here and the application fulfills the use case.
+## Running the demo:
+
+There are steps to build the container below, though I've published it, so you
+should be able to simply run:
+
+```shell
+$ docker run --rm \
+ -p 127.0.0.1:8080:8080 \
+ containers.riedstra.dev/dispatch-tracker:latest
+```
+
+Give it a solid 30 seconds or so, since the default configuration
+runs its own database, migrations, and then fills it with fake data
+and initial admin user account.
+
+These things can be tuned out with environment variables described in
+the `entrypoint.sh` file.
## Things to fix/add going forward: