Story-tools Composer

Deployment

Local Standalone

git submodule update --init --recursive
yarn build-serve
http://localhost:9090/

Docker

git submodule update --init --recursive
docker-compose build
docker-compose up -d
http://localhost:9090
To test: `docker-compose run --rm composer --test
To upgrade dependencies: docker-compose run --rm composer --dep-upgrade
Interactive shell:
- In a new container: docker-compose run --rm composer --shell
- In the container with the running server: docker-compose attach composer /bin/bash

Development

Adding layers

Navigate to the Story-layers tab and begin typing to see a list of available layers. Currently, the layers are being pulled from the mapstory.org Geoserver, and not all of them are functional. The one I've been using to test with is Green Iguana.

Style

Add less files for individual components to the component's relevant directory in app/.
In order for the style to be added to the bundled stylesheet used by the application, import it into style/style.js.
- Syntax example: import styles from ../app/map/style/map.less
All style's are bundled into style/bundle.css.

App Config

Global configuration constants are set in the app/app.js module constant appConfig object.

Testing

yarn run test

Accessing Viewer Mode

To view your Mapstory in viewer mode, add a hashbang (#!) followed by a query string with viewer set to true. ie, #!?viewer=true.

Developers!

This project is being created as a more lightweight and maintainable alternative to the MapLoom client. The application is leveraging the Story-tools library, which broadly has two sections:

a plain vanilla JavaScript library that provides various helpers for manipulating time data. This stuff can be found in the core and edit subdirectories in the lib directory of the repo.
A set of Angular directives that provide temporal UI components, which are discussed below. These directives live in the ng subdirectory of the lib directory.

The core functionality that the current product should provide is:

A time slider that allows temporal feature playback. This functionality is provided by the TimeController directive in Story-tools and already implemented.
Story-pins. These are features that are activated at a specific point or range in time during the playback of a Mapstory. Media can be embedded in the popups of these features. Check out the MapLoom Storypin component for an implementation of this. A lot of code from this implementation can probably be reused in this project, but should be refactored, tested, etc.
Story-frames, aka "story boxes." These are user-selected zoom scales and pan locations that can be associated with a point or range of time during the playback of a Mapstory.
Chapter Navigation. Mapstories can be broken into "chapters," which are individual Open Layers maps with their own associated layers, layer styles, pins, and frames.
Custom playback configurations. These configurations include playback speed; whether you would like a cumulative rather than instant view of your data as it plays across the time range of your map; and more. This is currently being handled through the time slider directive, but if you need to access any of the functionality outside of that component -- like if you wanted to change the map playback speed from the sidebar -- then the Story-tools playback settings template may be a good place to start.
Layer styling. This one's gonna be so fun. Talk to Emily Ashley about this. She knows more than me, your beloved README file.
Saving & loading. The Mapstory configuration that gets saved to the server should include an array of individual chapter configs, which are themselves an object containing: a reference to the layers that exist on the map; pins; boxes; and metadata information such as title, description, etc.

goudine / story-tools-composer Goto Github PK