This open-source template allows you to present the key findings of your survey paper in a convenient way.
It was originally developed by Lucas Joos for the paper Visual Network Analysis in Immersive Environments: A Survey (https://networks-ie-survey.dbvis.de). It consists of a React web application that is fully dockerized.
We provide this template under the MIT license.
As an example, this image shows the webpage accompanying our own survey paper:
The empty template:
As a starting point, your survey results need to be provided as a JSON file containing information about each paper with values for wanted dimensions, as well as icons representing possible values (see file data.json).
Put your icons into the icons folder inside public.
Some code changes need to be made, as indicated by comments in the code.
Now you can connect your data with the icons in tableHelper found in app:
- In
tableDim, define the names of the dimensions - In
tableEntry, define the types of the dimensions - In
columnDataIdMap, define which id in your data belongs to the name - Create maps for each dimension to link values to icons
- In
sideBarMap, connect the dimension names to the maps - Create functions for each dimension (dim1 example for string, dim2 for array)
The created functions have to be imported into overviewTable and added as TableCells.
Additionally, in the page file, it is possible to change the title, authors, contributing institutions, logos, date, email address, and other things.
After customizing the application, it is recommended to change the PRODUCTION value in the file docker.compose.yml to true. This will disable the code hot-reloading, which saves resources.
The application can be started on a system with Docker installed by executing docker-compose up from a terminal/shell with the root directory of this repository as the working directory.
The webpage will be available at http://localhost:3000.