README.md

Our Journey interactive student journey creator

Our Journey is an interactive online tool to chart the highs and lows of student journeys.

The aim is to produce a simple and accessible structure for students to represent the events that occurred in their study and their experience of these. It is being developed for use by all students and different institutions. The design is informed by research conducted to understand the challenges faced by disabled students at the Open University (see Coughlan & Lister, 2018 and Coughlan, Ullmann & Lister, 2017).

• ourjourney.ac.uk/v1

A physical version of the tool has been developed by Tim Coughlan and Kate Lister of the Institute of Educational Technology (IET) and Glen Darby in LTI Translation, with HEIF funding.

This prototype online version is being developed in the Institute of Educational Technology (IET), at The Open University.

Author: Tim Coughlan, IET.

Use

To integrate or extend our-journey:

npm i our-journey

Install .. build .. test

Use Node and npm to aid development:

npm install
npm run build
npm test

Other commands to serve and fix the code etc.:

npm run        # List lifecycle and other scripts.

npm start
npm run pa11y-ci
npm run fix
npm run jsdoc  # Generate documentation in /jsdoc/ directory.
npx eslint src # browserslist-based test.

API

URL parameters

• . . . . ?demo=1 — Load an empty demonstration journey;
• . .?layout=scol — Display with a single-column layout;
• . . ?edit=float — Use a floating editor;
• . ?j=base64:... — Load a journey represented in the URL parameter as Base64-encoded JSON;
• . . . .?zoom=75 — Zoom the display of the whole tool (50 .. 95%);
• . . . ?bg=wheat — Set the background colour;

Javascript

console.log('Inspect:', require('our-journey'));

require('our-journey').app.run({ assetUrl: '..' /* ... */ });

Example

Via unpkg — browse — production CDN:

<link href="https://unpkg.com/our-journey@^1/style/journeystyle.css" rel="stylesheet" />

<div id="our-journey-tool">
  <p class="no-js"> Sorry! This tool requires Javascript. </p>
</div>

<script src="https://unpkg.com/our-journey@^1/dist/our-journey.js"></script>

<script>
  require('our-journey').app.run({
    containerSelector: '#our-journey-tool'

    // Other options ...
  })
  // Returns a Promise.
  .then(function (value) {
    console.warn('Loaded', value);
  });
</script>

See the configuration options.

Changelog

See the release notes in the changelog.

Contributing

See the contributing guide.

GDPR

Details of GDPR / privacy actions can be found in Bug #51.

License

Distributed under the GNU General Public License, version 3 or later.

Copyright © 2018 The Open University. All rights reserved. (Institute of Educational Technology)