aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2e7f060
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Jobscope-sorter
+
+This is the source tree for a web-based tool that sorts Jobscope work
+order PDFs. The backend runs on Node.js and uses ExpressJS for serving
+requests. The actual sort code consists of a Bash shell script that
+uses PDFTk and AWK to sort the PDF's pages.
+
+The tool is meant to be packaged as a Docker container. The Dockerfile
+in this directory contains the instructions for building a container
+image. By default, the container listens on port 8080. This can easily
+be changed with the -p switch to `docker run'.
+
+## Deployment
+
+Run:
+
+ docker build . -t jobscope
+ docker run -p 8080:8080 jobscope
+
+This will run the server on http://localhost:8080