This is a Kettle-based server that uses the SJRK Story Telling components plus CouchDB to create a web application that allows for the creation and viewing of accessible multimodal stories.
npm install
to install dependencies- Run a CouchDB server on
localhost:5984
(Docker is an easy way to do this) - Run
src/js/db/dbSetup.js
to configure necessary CouchDB databases (this will also ensure your CouchDB instance is set up in single-node mode) - Create a
secrets.json
file in the style ofsecrets.json.example
- Run
node index.js
to launch the server
Custom themes can be added to the Storytelling Tool by a process detailed in the documentation of the UI project. If you have a set of custom theme grades and files that you would like to use, you need to:
- In the part of storyTellingServerUI.js that defines the
templates
variable, add an entry for your new custom theme that contains any DOM elements that are required to inject markup or templates.- e.g.
myCustomTheme: { view: '<div class="sjrk-pageBody-container sjrk-pageBody-container-oneColumn"> YOUR CUSTOM CONTAINERS GO HERE </div>', edit: '<div class="sjrk-pageBody-container sjrk-pageBody-with-sidebars"> YOUR CUSTOM CONTAINERS GO HERE </div>', browse: '<div class="sjrk-pageBody-container sjrk-pageBody-container-oneColumn"> YOUR CUSTOM CONTAINERS GO HERE</div>' }
- e.g.
- In each of the HTML files in the
ui
directory, update the call tosjrk.storyTelling.server.loadThemedPage
to use your desired theme- e.g.
sjrk.storyTelling.server.loadThemedPage("browse", "myCustomTheme", function (theme) { sjrk.storyTelling.server.loadBrowse(theme); });
- e.g.
docker-compose -f docker-compose.yml -f docker-compose.dev.yml build --no-cache
docker-compose -f docker-compose.yml -f docker-compose.dev.yml up
docker-compose -f docker-compose.yml -f docker-compose.cloud.yml up