Skip to content

Commit e0062d1

Browse files
committed
updated README (added new examples and screenshot)
1 parent 3abfcfa commit e0062d1

2 files changed

Lines changed: 18 additions & 5 deletions

File tree

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@ Head Start is a web-based knowledge mapping software intended to give researcher
99
### Client
1010
To get started, clone this repository. Next, duplicate the file `config.example.js` in the root folder and rename it to `config.js`.
1111

12+
Set the `skin` property in the config to one of the following values to use the
13+
particular data integration skin:
14+
15+
- `"covis"`
16+
- `"triple"`
17+
- `"viper"`
18+
19+
or leave it empty (`""`) for the default project website skin.
20+
1221
Make sure to have installed `node` version >= 14.18.1 and `npm` version >=8.1.1 (best way to install is with [nvm](https://github.com/nvm-sh/nvm), `nvm install 14.18.1`) and run the following two commands to build the Headstart client:
1322

1423
npm install
@@ -20,16 +29,20 @@ Now you can run a local dev server:
2029

2130
npm start
2231

23-
To run Headstart on a different server (e.g. Apache), you need to set the publicPath in `config.js` to the URL of the `dist` directory:
24-
* Dev: specify the full path including protocol, e.g. `http://localhost/headstart/dist`
25-
* Production: specify the full path excluding protocol, e.g. `//example.org/headstart/dist`
26-
2732
Point your browser to one of the following addresses:
2833

2934
http://localhost:8080/project_website/base.html
3035
http://localhost:8080/project_website/pubmed.html
36+
http://localhost:8080/local_covis/
37+
http://localhost:8080/local_triple/map.html
38+
http://localhost:8080/local_triple/stream.html
39+
http://localhost:8080/local_viper/
40+
41+
If everything has worked out, you should see the example visualization.
3142

32-
If everything has worked out, you should see the visualization shown above.
43+
To run Headstart on a different server (e.g. Apache), you need to set the publicPath in `config.js` to the URL of the `dist` directory:
44+
* Dev: specify the full path including protocol, e.g. `http://localhost/headstart/dist`
45+
* Production: specify the full path excluding protocol, e.g. `//example.org/headstart/dist`
3346

3447
See [client configuration](doc/README.md) for details on adapting the client.
3548

headstart.png

255 KB
Loading

0 commit comments

Comments
 (0)