aboutsummaryrefslogtreecommitdiff
path: root/backend/README.md
diff options
context:
space:
mode:
authorTerry Truong <terry06890@gmail.com>2022-06-28 02:10:17 +1000
committerTerry Truong <terry06890@gmail.com>2022-06-28 02:18:27 +1000
commitd4431d3d200a77f7abfa00e5adc848c633597352 (patch)
tree7e2fa4d1e2d64ed0d570c46af78a2363b959f9af /backend/README.md
parent96bb515a603499abb016d381f0bdb5bd51ebda92 (diff)
Convert server code to CGI scriptdeployable
Also adjust server-client API, for clarity/consistency
Diffstat (limited to 'backend/README.md')
-rw-r--r--backend/README.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/backend/README.md b/backend/README.md
index 20263fd..3efa585 100644
--- a/backend/README.md
+++ b/backend/README.md
@@ -1,3 +1,8 @@
# Files
-- server.py: Runs the server
-- data/: For generating the server's tree-of-life database
+- cgi-bin/data.py: CGI script for providing tree-of-life data to client
+- data: Contains scripts for generating the tree-of-life database
+
+# During development
+Having generated the database as data/data.db, and with this as the current
+directory, running `python3 -m http.server --cgi 8000` allows the client to access
+the CGI script, and hence the database, via `localhost:8000/cgi-bin/data.py`.