You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Include a brief description of the client architecture (SSR/Proxy to Fractal)
- Include notes on .env.development default development configuration file
Copy file name to clipboardExpand all lines: README.md
+17-3Lines changed: 17 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,12 +32,20 @@ npm install
32
32
33
33
## Web client startup
34
34
35
-
Create a `.env` file where you set the relevant environment variables. At the moment this includes a single variable:
35
+
The project comes with a default `.env.development` development environment file.
36
+
In this file are present a set of default values for the environment variables that are used by the application.
37
+
The default values are set to work with a local instance of a fractal-server.
38
+
39
+
Specifically, a fractal server is expected to run on `http://localhost:8000` as stated by the `FRACTAL_SERVER_HOST` variable.
40
+
41
+
If you want to run the application with a different fractal server instance, you can create a `.env.development.local` file
42
+
and override, for instance, the `FRACTAL_SERVER_HOST` variable with the address of your server instance, e.g.
43
+
36
44
```
37
-
PUBLIC_FRACTAL_SERVER_HOST=http://127.0.0.1:8000
45
+
FRACTAL_SERVER_HOST=http://localhost:8888
38
46
```
39
47
40
-
Run the application via
48
+
Run the client application via
41
49
```bash
42
50
npm run dev -- --open
43
51
```
@@ -57,6 +65,12 @@ For user experience reasons, it is suggested to set the `JWT_EXPIRE_SECONDS=8460
57
65
58
66
**Note**: The [example_server_startup folder](tests/data/example_server_startup) contains an example of how to install and startup a `fractal-server` instance.
59
67
68
+
# Client architecture
69
+
70
+
The client is a Svelte application that uses [SvelteKit](https://kit.svelte.dev) as a framework.
71
+
The application is composed of a set of pages that are rendered by a node server and served to a client browser.
72
+
The node server acts as a proxy to the fractal server, forwarding the requests to the server and returning the responses to the client.
73
+
60
74
# Contributors
61
75
62
76
Fractal was conceived in the Liberali Lab at the Friedrich Miescher Institute for Biomedical Research and in the Pelkmans Lab at the University of Zurich (both in Switzerland). The project lead is with [@gusqgm](https://github.com/gusqgm) & [@jluethi](https://github.com/jluethi). The core development is done under contract by [eXact lab S.r.l.](exact-lab.it).
0 commit comments