Skip to content

Commit 29a8632

Browse files
committed
Improved README
1 parent f031b8b commit 29a8632

File tree

1 file changed

+20
-29
lines changed

1 file changed

+20
-29
lines changed

README.md

Lines changed: 20 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ inspect the corresponding results.
66
Table of contents:
77

88
* [Preface](#preface)
9-
* [Getting Started](#getting-started)
9+
* [Getting started](#getting-started)
10+
* [The supporting resources](#the-supporting-resources)
1011
* [Static, production build](#static-production-build)
1112
* [Logging in](#logging-in)
1213
* [Configuration file](#configuration-file)
@@ -27,9 +28,10 @@ Table of contents:
2728

2829
This repository defines a Web application in the directory `main` and some auxiliary tools for testing and supporting a demo in the directory `test`.
2930

30-
## Getting Started
31+
## Getting started
3132

32-
Go to directory `main`.
33+
The application is located in directory `main`.
34+
Go to that directory.
3335

3436
To install the application:
3537

@@ -45,30 +47,35 @@ npm run dev
4547

4648
Now you can browse the displayed URL.
4749

48-
The queries provided in the example configuration `main/src/config.json` access data located in pods at localhost.
49-
To have these up and running, you need to install the auxiliary tools first.
50+
If you want to test the queries provided in the default configuration `main/src/config.json`,
51+
continue in section [The supporting resources](#the-supporting-resources).
5052

51-
Go to directory `test` and execute:
53+
## The supporting resources
54+
55+
The supporting resources, including a local pod containing example data, are located in directory `test`.
56+
57+
To install, go to directory `test` and execute:
5258

5359
```bash
5460
npm install
5561
```
5662

57-
Next, also in directory `test`, activate the supporting resources:
63+
Next, activate the supporting resources by executing each of the following steps
64+
in a new terminal window, also in directory `test`:
5865

59-
1. In a new terminal window, prepare and start the local pods:
66+
1. Prepare and start the local pods:
6067

6168
```bash
6269
npm run reset:pods && npm run start:pods
6370
```
6471

65-
2. In a new terminal window, start the http proxy:
72+
2. Start the http proxy:
6673

6774
```bash
6875
npm run start:proxy
6976
```
7077

71-
3. In a new terminal window, start a server which denies all CORS headers:
78+
3. Start a server which denies all CORS headers:
7279

7380
```bash
7481
npm run start:badCors
@@ -87,7 +94,7 @@ In directory `main`, execute:
8794
npm run build
8895
```
8996

90-
The static build appears in the `dist` folder.
97+
The static build appears in directory `main/dist`.
9198

9299
## Logging in
93100

@@ -336,25 +343,9 @@ The development version might be tested repeatedly during development.
336343
npm run serve
337344
```
338345

339-
2. In a new terminal window, in directory `test`, prepare and start the local pods:
340-
341-
```bash
342-
npm run reset:pods && npm run start:pods
343-
```
344-
345-
3. In a new terminal window, in directory `test`, start the http proxy:
346-
347-
```bash
348-
npm run start:proxy
349-
```
350-
351-
4. In a new terminal window, in directory `test`, start a server which denies all CORS headers:
352-
353-
```bash
354-
npm run start:badCors
355-
```
346+
2. Spin up all supporting resources, as explained in [The supporting resources](#the-supporting-resources).
356347

357-
5. Finally, in a new terminal window, in directory `test`, you can execute the tests by running:
348+
3. Finally, in a new terminal window, in directory `test`, you can execute the tests by running:
358349

359350
For normal test execution:
360351

0 commit comments

Comments
 (0)