Skip to content

Commit 57338e8

Browse files
committed
More documentation updates.
1 parent c0de4c0 commit 57338e8

File tree

2 files changed

+35
-37
lines changed

2 files changed

+35
-37
lines changed

README.md

Lines changed: 32 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -14,29 +14,48 @@ Table of contents:
1414
* [Query icons](#query-icons)
1515
* [Representation Mapper](#representation-mapper)
1616
* [Using the local pods](#using-the-local-pods)
17-
* [Using a local http proxy](#using-a-local-http-proxy)
1817
* [Testing](#testing)
1918
<!-- TOC -->
2019

2120
## Getting Started
2221

23-
After installing, the following steps suffice to install the application:
22+
To install the application:
2423

2524
```bash
2625
npm install
2726
```
2827

29-
after this you can execute
28+
To run the Web application in development mode:
3029

3130
```bash
3231
npm run dev
3332
```
3433

35-
which will start the web application. Now you can browse the displayed URL.
34+
Now you can browse the displayed URL.
3635

37-
If you want to run with the provide example configuration `src/config.json` however, you first need to complete the steps
38-
described in [using the local pods](#using-the-local-pods) and [using a local http proxy](#using-a-local-http-proxy).
39-
Do each of these in their own separate terminal window.
36+
To see the queries provided in the example configuration `src/config.json` at work,
37+
you also need to activate the supporting resources:
38+
39+
1. In a new terminal window, prepare and start the local pods:
40+
41+
```bash
42+
npm run prepare:pods && npm run start:pods
43+
```
44+
45+
2. In a new terminal window, start the http proxy:
46+
47+
```bash
48+
npm run start:proxy
49+
```
50+
51+
3. In a new terminal window, start a server which denies all CORS headers:
52+
53+
```bash
54+
npm run start:badCors
55+
```
56+
57+
Some queries require a log in.
58+
Log in with the IDP `http://localhost:8080` and the credentials for the user owning the pod named `example` in the file `seeded-pod-config.json`.
4059

4160
## Static build
4261

@@ -174,57 +193,36 @@ You can make use of these for your own tests. Follow these steps:
174193
- Add your data and `.acl` files in the `initial-pod-data` folder.
175194
These files will be available in the pod relative to `http://localhost:8080/example/`.
176195
- Prepare the pods by executing `npm run prepare:pods`.
177-
- Start the pods by executing `npm run start:pods`.
178-
- Add your query as described in [the configuration file section](#configuration-file).
179-
- Log in with the IDP `http://localhost:8080` and the credentials for the user owning the pod named `example` in the file `seeded-pod-config.json`.
180-
181-
## Using a local http proxy
182-
183-
To use a local http proxy through which the requests will be rerouted execute the following command:
184-
185-
```bash
186-
npm run start:proxy
187-
```
188-
189-
which will start a proxy on port `8000`.
190196

191197
## Testing
192198

193-
For testing we use [Cypress](https://www.cypress.io/).
199+
For testing we use [Cypress](https://www.cypress.io/). To test, follow the next steps:
194200

195-
1. Prepare and start the Community Solid Server with the available pods as explained in [Using the local pods](#using-the-local-pods).
201+
1. Prepare and start the local pods:
196202

197203
```bash
198204
npm run prepare:pods && npm run start:pods
199205
```
200206

201-
Keep this process running and continue in a new terminal window.
202-
203-
2. Start the Web application
207+
2. In a new terminal window, start the Web application:
204208

205209
```bash
206210
npm run dev
207211
```
208212

209-
Keep this process running and continue in a new terminal window.
210-
211-
3. Start the http proxy
213+
3. In a new terminal window, start the http proxy:
212214

213215
```bash
214216
npm run start:proxy
215217
```
216218

217-
Keep this process running and continue in a new terminal window.
218-
219-
4. Start a server which denies all cors header
219+
4. In a new terminal window, start a server which denies all CORS headers:
220220

221221
```bash
222222
npm run start:badCors
223223
```
224224

225-
Keep this process running and continue in a new terminal window.
226-
227-
5. Finally, you can execute the tests by running
225+
5. Finally, in a new terminal window, you can execute the tests by running:
228226

229227
```bash
230228
npm run test

src/config.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
{
1717
"queryLocation": "idols.rq",
1818
"name": "My idols",
19-
"description": "A simple Test query",
19+
"description": "A simple test query",
2020
"id": "1000",
2121
"comunicaContext": {
2222
"sources": ["http://localhost:8001/example/idols"],
@@ -96,7 +96,7 @@
9696
{
9797
"queryLocation": "musicians_variables.rq",
9898
"name": "Templated query about my favourite musicians",
99-
"description": "In this query you can get a list of my favourite musicians for the genre of your choice",
99+
"description": "A list of my favourite musicians for the genre of your choice",
100100
"id": "5100",
101101
"icon": "MusicNoteIcon",
102102
"variables": {
@@ -113,7 +113,7 @@
113113
{
114114
"queryLocation": "musicians_variables2.rq",
115115
"name": "Templated query #2 about my favourite musicians",
116-
"description": "The purpose of this query is to show an example of a templated query with more than one variable",
116+
"description": "An example of a templated query with more than one variable",
117117
"id": "5200",
118118
"icon": "MusicNoteIcon",
119119
"variables": {

0 commit comments

Comments
 (0)