aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 1f3b62a2b150c079ba52ee17b1911d40e21677ce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# GN4 Guile Webservice

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).

# Development

The current repository lives at

```sh
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

```sh
cd web
unset GUIX_PROFILE
. .guix-shell -- guile -L .. --fresh-auto-compile --listen=1970 -e main ./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.

## 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.

# Tools

Some tooling and scripts that run independently are stored in `./scripts`.



# Development

```
git remote add gn git.genenetwork.org:/home/git/public/gn-guile
```

# Topics

* More on [gn-guile](./doc/gn-guile.md)
* Markdown editor with git backend see [markdown](./doc/git-markdown-editor.md).

# LICENSE

This software is published by the GeneNetwork team under the AGPL3. See [LICENSE](LICENSE.txt).