aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..be7aeaf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# spa
+
+Example SPA approach to a simple blog website.
+
+## prerequisites
+- [caddy web server](https://caddywebserver.com)
+
+## run
+launch with `caddy run` and open the browser to http://localhost
+
+## how it works
+
+caddy tries to load from files, and falls back to index.html by default if no file matches.
+
+[index.html](./index.html) has a plain page template and uses javascript to dynamically create navigation and load the content.
+
+[routes.json](./routes.json) file contains the metadata for website pages (currently just title and content location)
+
+content/* files are HTML content to be embedded in the page template.
+
+assets/* files are just plain files to be served direct. \ No newline at end of file