https://github.com/MapStory/story-tools

https://github.com/MapStory/story-tools

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/MapStory/story-tools
• Owner: MapStory
• License: mit
• Created: 2014-11-03T20:14:56.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2019-10-10T01:28:49.000Z (about 5 years ago)
• Last Synced: 2024-08-01T12:33:37.392Z (3 months ago)
• Language: JavaScript
• Size: 14.2 MB
• Stars: 8
• Watchers: 16
• Forks: 10
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - MapStory/story-tools - (others)

README

        
[![Build Status](https://travis-ci.org/MapStory/story-tools.svg?branch=master)](https://travis-ci.org/MapStory/story-tools)

# story-tools

## Installation

run

```

    npm install

    bower install

    gulp develop

```

If you haven't used or installed Gulp previously, you may also need to run

`npm install --global gulp-cli` before running `gulp develop`.

Alternatively, run

```

    docker-compose build

    docker-compose up

```

## Accessing the examples

Example index will be available at: http://localhost:8001

## Getting around

There are 3 large distinctions in the structure and bundling of code:

* core - any core viewing/playback logic + provided UI

  this includes API, controller logic and the timeline and timeslider UI

* edit - any non-UI editing related logic, parsing, etc.

* ng - angular wrappers/integration for both core and edit

Within these categories, the specific functionality includes (not all physically separate):

* time - timeline and timeslider integration

* style - ol3/SLD styling

* pins - spatial story-telling annotations

* boxes - spatial story-telling chapters

* layout - layout of viewing mode

## Running tests in the browser

run

    gulp karma --server

Karma will be available at: http://localhost:9876/debug.html