Skip to content

AnatomicMaps/flatmap-viewer

Repository files navigation

Flatmap Viewer

A viewer for anatomical flatmaps generated by flatmap-maker. The viewer is intended to be a component of a larger Javascript web application, although may be used standalone for local flatmap development and testing. Flatmap content is obtained from a flatmap-server.

Standalone Use

Requirements

Installation

  1. Clone this repository.
  2. Run npm install

Running

$ npm run dev

Maps can then be viewed at http://localhost:3000

Configuration

The map server endpoint is specified as MAP_ENDPOINT in src/main.js. It defaults to http:localhost:4329/, which matches the default endpoint of a local flatmap server.

Package Installation

  • npm install @abi-software/flatmap-viewer@3.2.0

Documentation

The API is documented at Read the Docs.