Skip to content

Commit e47f1c8

Browse files
committed
Update project README.md
- Include a brief description of the client architecture (SSR/Proxy to Fractal) - Include notes on .env.development default development configuration file
1 parent db9571c commit e47f1c8

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,20 @@ npm install
3232

3333
## Web client startup
3434

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+
3644
```
37-
PUBLIC_FRACTAL_SERVER_HOST=http://127.0.0.1:8000
45+
FRACTAL_SERVER_HOST=http://localhost:8888
3846
```
3947

40-
Run the application via
48+
Run the client application via
4149
```bash
4250
npm run dev -- --open
4351
```
@@ -57,6 +65,12 @@ For user experience reasons, it is suggested to set the `JWT_EXPIRE_SECONDS=8460
5765

5866
**Note**: The [example_server_startup folder](tests/data/example_server_startup) contains an example of how to install and startup a `fractal-server` instance.
5967

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+
6074
# Contributors
6175

6276
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

Comments
 (0)