Flatmap Viewer

A web-browser viewer for anatomical flatmaps generated by flatmap-maker. The viewer is intended to be used as a component in a web application, although it can be used standalone for local flatmap development and testing. Flatmap content is obtained from a flatmap-server.

Package Installation

• bun install @abi-software/flatmap-viewer@4.6.1

Standalone Use

Requirements

• nodejs JavaScript runtime environment.
• bun Node package manager.

Installation

1. Clone this repository.
2. Run bun install in the checked out working directory.

Configuration

Map server endpoints are defined by MAP_ENDPOINTS in app/index.ts. The first endpoint listed is used as the default, this being the default endpoint for a local flatmap server.

Running

$ bun start
Copy

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

Example usage

See here