Skip to content

Latest commit

 

History

History
135 lines (85 loc) · 6.14 KB

README.md

File metadata and controls

135 lines (85 loc) · 6.14 KB
Raw

WODIN

odin on the web.

Introduction

WODIN is a web application with a Node.js back end using Express, and a Vue.js front end. Both parts are written in Typescript.

The WODIN application can be deployed with custom configuration to create teaching courses that allow students to author and run model code using odin.

When the user runs a model in WODIN, odin will be invoked to provide executable JavaScript for odin model code. This odin code may be written by the user or provided in config.

WODIN configuration defines multiple 'apps', corresponding to teaching modules, which each provide functionality for one of three types of model usage:

  • basic - to teach the basics of odin model definitions
  • fit - to fit a model to data
  • stochastic - to run a model stochastically

Each app will have one of these three app types, as well as any further configuration required e.g. default odin code.

Usage and configuration

WODIN fetches compiled odin code from odin.api, which should be run locally using ./scripts/run-dev-dependencies.sh.

For development, you can install all dependencies and serve the app, with hot reloading, using two terminals. In one terminal, use ./scripts/serve-backend.sh to run the server. In another terminal use ./scripts/serve-frontend.sh. The app will be available at http://localhost:3000.

You can also install dependencies, build and run the app locally in one step using ./scripts/build-and-run.sh. The app will be available at http://localhost:3000

To build front end changes only run ./scripts/build-frontend.sh.

WODIN is deployable via an npm package: https://www.npmjs.com/package/wodin

To run an instance of WODIN with custom configuration, install the package and use npx wodin /path/to/config

The path provided in the config argument should be an absolute path to a root config folder containing the following:

wodin.config.json

Contains the following settings for the WODIN instance:

  • port: the port number at which WODIN should be served
  • appsPath: the url path under root at which each app should be available e.g /apps/day1 for appPath of "apps" and app name "day1"
  • odinApi: base url for the running instance of odin.api to use

index.html

A root index page index.html should be provided which will be available at the root url / and should provide a front page for all apps, including any description and explanation along with links to apps and data files.

index.html may also use files included in the /files folder e.g. images or css.

/[appsPath]/*.config.json

Each config.json file defines config values for an app. The app will be available at /[appsPath]/[appName] for a config file named [appName].config.json. [appsPath] is defined in wodin.config.json. Note that the local config folder should match appsPath too.

Each app config file should contain the following settings:

  • appType: "basic", "fit" or "stochastic"
  • title: the app title which will be visible to the user
  • readOnlyCode: boolean indicating whether default code should not be editable by the user
  • stateUploadIntervalMillis (optional): number of milliseconds to wait after front end state changes before state will be saved to the server. Increase this value if too frequent requests are causing issues. Default is 2000.

/defaultCode/*.R

Default odin code for an application (if any) should be provided in the /defaultCode folder, in a file named [appName].R.

/files

Sample data and other supporting files can be provided in any folder structure under /files and will be available at urls under /files

See the /config folder for example configuration, used in development.

Development

This codebase has been tested with Node version 16.16.0. If you have recently changed node version, you may see Node Sass binding errors - running npm rebuild node-sass --prefix=app/static should fix this issue.

Frontend

Front-end source can be found under app/static/src. The front end can be built by running npm run build from app/static. This builds output to be picked up by the back end at app/server/public.

The entry point script is app/static/src/app/wodin.ts.

Unit Tests

Run unit tests from app/static using npm run test:unit. Run eslint with npm run lint or npm run lint:fix.

Backend

The back end handles requests for apps by reading the corresponding config files and rendering an html Handlebars template views/app.hbs which uses the built front end js file, and also provides configuration from the appConfig object via the top-level WodinSession component. It also sets an appType variable which is used by wodin.ts to select which type of store to initialise.

The back-end server can be built using npm run build and run using npm run serve, both from app/server.

Unit Tests

Run tests from app/server using npm test. Run eslint with npm run lint or npm run lint:fix.

Integration Tests

From app/server using npm run integration-test

Browser tests

Browser tests use Playwright. Run browser tests, while the app is running, using npm run e2e-test from app/static.

Publishing

To publish to npm:

  • build both front end and and back end
  • increment the version in /app/server/package.json
  • run npm run genversion from /app/server to update the version number in src/versions.ts
  • then npm publish --access public, from /app/server folder (may need to npm login first)

Usage via docker

The build includes a docker image build which may be easier to deploy. See wodin-demo for an example.

Quickly test drive a feature branch

Use the ./scripts/run-version.sh script setting the branch references for the app and api (defaults to main for both):

./scripts/run-version.sh --app mrc-1234 --api mrc-2345