diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 64 |
1 files changed, 53 insertions, 11 deletions
diff --git a/README.md b/README.md index c7f367b..79b00bd 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,17 @@ 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. +## Run + +1. **Navigate to the Web Directory and Start the Server** + +Running the web server is documented in [guix script](./web/.guix-shell). + +``` +curl http://127.0.0.1:8091/version +"4.0.0" +``` + # Documentation Start with this file and then the documentation in [doc](./doc/gn-guile.md). @@ -14,28 +25,59 @@ The current repository lives at git clone tux02.genenetwork.org:/home/git/public/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 from the `web` directory as +or + +``` +git remote add gn git.genenetwork.org:/home/git/public/gn-guile +``` + +GNU Guile allows you to develop against a live running web server using emacs-geiser on port 1970. To try this fire up the web server from the `web` directory as ```sh -cd web -unset GUIX_PROFILE -. .guix-shell -- guile -L .. --listen=1970 -e main ./webserver.scm 8091 +guix shell -L ~/guix-bioinformatics -m manifest.scm --container --network --file=guix.scm -- guile -L . --fresh-auto-compile --listen=1970 -e main web/webserver.scm 8091 ``` -Note the leading dot. The .guix-shell is defined in `gn-guile/web` and loads required packages using GNU Guix. -If you are on Debian you may need to unset GUIX_PROFILE first. +By default the root points to the API: + +curl http://127.0.0.1:8091 + +We also have some services + +curl http://127.0.0.1:8091/home/msk +curl http://127.0.0.1:8091/home/aging + +The `--container` option runs the code in an isolated container, and the `--network` option connects that container's networking to the host to allow you to access the running service. + +If you get an error `no code for module (gn packages guile)` add the appropriate guix-bioinformatics repo to the load path (`-L` switch). Note that, instead of hard-wiring guix-bioinformatics, the recommended way is to use a guix channel as defined in [guix-channel](./.guix-channel). + +We recommend checking the Guix documentation for manifests, channels and guix.scm definitions. + +## Welcome to the world of interactive Lisp programming + +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` on code, call and get updated output from the webserver! No need to save/reload files and all that. + +Note that you may have to try different versions of guile+emacs to succeed. + +Also these days it may be a better bet to use Andrew Tropin's alternatives ares and arei that are very powerful alternatives to geiser (with a more common lisp type interactive experience): + +=> https://git.sr.ht/~abcdw/guile-ares-rs +=> https://git.sr.ht/~abcdw/emacs-arei -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! # Tools Some tooling and scripts that run independently are stored in `./scripts`. -# Development +# Forwarding a MySQL port -``` -git remote add gn git.genenetwork.org:/home/git/public/gn-guile -``` +You may want to forward a mysql port if there is no DB locally you can do something like: + +ssh -L 3306:127.0.0.1:3306 -f -N tux02.genenetwork.org + +# Topics + +* More on [gn-guile](./doc/gn-guile.md) +* Markdown editor with git backend see [markdown](./doc/git-markdown-editor.md). # LICENSE |