Getting Started with the Web Interface¶
Here, we document how to install and build the CaosDB Web Interface. If you are only interested in how to use it, please continue here
srcfolder contains all source code for the web interface.
libsfolder contains all necessary third-party libraries as zip files.
testfolder contains the unittests for the web interface.
miscfolder contains a simple http server which is used for running the unit tests.
build.properties.d/folder contains configuration files for the build.
The default configuration is defined in
This file defines default variables which can be used in source files and will be replaced with the defined values during the build.
All files in that directory will be sourced during
make install and
Thus any customized configuration can also be added to that folder by just placing
files in there which override the default values from
build.properties.d/00_default.properties for more information.
make installto compile/copy the web interface to a newly created
make installwill copy the scripts from
sss_bin/. If you want to make the server-side scripts callable for the server as server-side scripts you need to include the
sss_bin/directory into the server property
make testto compile/copy the web interface and the tests to a newly created
make run-test-serverto start a python http server.
The test suite can be started with
make cleanto clean up everything.
Build documentation in
npm install jsdoc)
npm install jsdoc-sphinx)