You need to have node, npm installed
To get Started with developing clone the repository, install the dependencies and you are ready to go.
Go to the project folder and install the dependencies
´´´ npm i ´´´
To start the local development server go to the project folder and execute
npm start
The App is serve on http://localhost:3000/
To run the tests on your local machine go to the project folder and execute
npm run test
To build the Project go to the project folder and execute
npm run build
A Production Version is build into the folder "build/"
The Ink file describes the dialog structure of the trail.
There are some guidelines to ensure compatibility with the SENSO Trail App:
Additional Data beyond the dialog text is provided via Tags. Tags are defined with a leading hashtag
# tag
There are two relevant types of tags.
Global Tags are not associated with a specific dialog line. Global tags are in normal ink files defined at the top of the ink file. In our structure we define all Global tags in the data.ink file and include it at the top of the main ink file. It is essential to include no other file before including the data File
Lokal Files are associated with a specific dialog line. They are positioned at the end of the corresponding dialog line.
Hello I say some dialog text # tag1 # tag2
It is possible to define multiple tags for a corresponding dialog line.
To ensure that the App understands what to do with the additional data provided by the Tag we follow some guidlines. Every type of data has its own structure All tags first define their type of data (station, audio, image). Followed by an colon and the actual data.
# <datatype>:<data>
The station Tag is defined as a global Tag. It follows the folowing structur
# station:knotname latitude longitude
# audio:audio-file.mp3
# image:image-file.jpg
To tell the App which files to preload every image or audiofile that is associated with a dialog line should be defined as a global tag as well.