Web-based visual analytics for NoSQL data, powered by Quasar.
See the Use with Quasar section for next steps.
Building SlamData requires Node.js v6 or newer. The app is written in PureScript, the appropriate version of the PureScript compiler will be installed as part of the npm dependencies (see below).
This can be skipped if Bower is already installed globally.
npm install bower -g
git clone git@github.com:slamdata/slamdata.git
Inside the slamdata repository directory:
bower install
npm install
npm run build:prod
After this task finishes the public directory will contain the complete SlamData front-end app.
npm run build:dev
Webpack will run a watch on files in the output directory for any changes and automatically rebundle when they are updated.
To complete the development workflow it is recommended to also have watch runing on the src directory to the .purs files so they will recompile automatically on saves.
This can be achieved by using psc-ide with editor of choice, or alternatively run:
npm run build:dev-pulp
Quasar can host the SlamData front-end app on the same port as the API. To do this, use the --content-path command-line argument when starting the engine:
java -jar [<path to quasar jar>] --content-path [<path to slamdata app>]
Where [<path to slamdata app>] is the location of the source-built public folder, or the extracted contents of a pre-built archive.
Users can add custom styles to notebooks by adding a query parameter to the URI.
For example, to add a stylesheet located in css/foo.css to
http://slamdata.instance.com/notebook.html#/db/Folder/Notebook.slam/view
one should modify the route to
http://slamdata.instance.com/notebook.html?stylesheets=css/foo.css#/db/Folder/Notebook.slam/view
The values of stylesheets are decoded and then split by ,, so to add two stylesheets one could use
stylesheets=css/foo.css,http%3A%2F%2Ffoo.com%2Fstyles.cssstylesheets=css%2Ffoo.css,http%3A%2F%2Ffoo.com%2Fstyles.cssstylesheets=css%2Ffoo.css%2Chttp%3A%2F%2Ffoo.com%2Fstyles.css
These URIs are checked and, if they are valid, corresponding link elements are added to the head
Here it would be
<link type="text/css" rel="stylesheet" href="css/foo.css">
<link type="text/css" rel="stylesheet" href="http://foo.com/style.css">Working with Quasar Advanced, the user can add permission tokens to the URI, which will be sent with every ajax request.
For example to add permission tokens ABCD and 1234 to
http://slamdata.instance.com/notebook.html#/db/Folder/Notebook.slam/view
one should modify the route to
http://slamdata.instance.com/notebook.html?permissionsToken=ABCD,1234#/db/Folder/Notebook.slam/view
These tokens then will be added to X-Extra-Permissions header.
The value of permissionsToken can be url-encoded: ABCD,1234 is equal with ABCD%2C1234.