aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPjotr Prins2023-08-06 10:32:17 +0200
committerPjotr Prins2023-08-06 10:32:17 +0200
commitdedcfeee0ce72539f0789923229c54b00f23605d (patch)
tree29a4b70e98404bc8f293b4bb232f55d689221a1b /README.md
parent3395ec582bb6f0a3c9f79f264789c77986dd9878 (diff)
downloadgn-guile-dedcfeee0ce72539f0789923229c54b00f23605d.tar.gz
README
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/README.md b/README.md
index 3a9b167..1515809 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,22 @@
# GN3 Guile Webservice
-This directory provides a Guile endpoint for the REST API. It is used in conjunction with the Python REST API and WIP.
+This directory provides a Guile web service incl. the new REST API. It is used in conjunction with the Python web services and (very much) WIP.
-GNU Guile allows you to develop against a live running web server using emacs-geiser. To try this fire up the web server as
+# Development
+
+The current repository lives at
+```sh
+git clone tux02.genenetwork.org:/home/git/genenetwork/gn-guile
```
+
+GNU Guile allows you to develop against a live running web server using emacs-geiser. To try this fire up the web server as
+
+```sh
+cd web
. .guix-shell -- guile --listen=1970 -e main ./webserver.scm 8091
```
-Note the leading dot. The .guix-shell is defined in `genenetwork3/gn3-guile/web` and loads required packages using GNU Guix.
+Note the leading dot. The .guix-shell is defined in `genenetwork3/gn3-guile/web` and loads required packages using GNU Guix.
Next fire up emacs with `emacs-geiser-guile` and connect to the running web server with `M-x geiser-connect` and the port `1970`. Now you can not only inspect procedures, but also update any prodedure on the live server using `C-M-x` and get updated output from the webserver!
-
-