@abi-software/flatmap-viewer 4.2.0 → 4.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +17 -13
  2. package/dist/index.js +25152 -24644
  3. package/package.json +7 -3
package/README.md CHANGED
@@ -1,36 +1,40 @@
1
1
  # Flatmap Viewer
2
2
 
3
- A viewer for anatomical flatmaps generated by [flatmap-maker](https://github.com/AnatomicMaps/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](https://github.com/AnatomicMaps/flatmap-server).
3
+ A web-browser viewer for anatomical flatmaps generated by [flatmap-maker](https://github.com/AnatomicMaps/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](https://github.com/AnatomicMaps/flatmap-server).
4
4
 
5
5
  ## Package Installation
6
6
 
7
- * `pnpm install @abi-software/flatmap-viewer@4.2.0`
7
+ * `pnpm install @abi-software/flatmap-viewer@4.2.2`
8
+
9
+ ---
8
10
 
9
11
  ## Standalone Use
10
12
 
11
13
  ### Requirements
12
14
 
13
- * [nodejs](https://nodejs.org/en/download/)
15
+ * [nodejs](https://nodejs.org/) JavaScript runtime environment.
16
+ * [pnpm](https://pnpm.io) Node package manager.
14
17
 
15
18
  ### Installation
16
19
 
17
- 1) Clone this repository.
18
- 2) Run `pnpm install`
20
+ 1. Clone this repository.
21
+ 2. Run `pnpm install` in the checked out working directory.
22
+
23
+
24
+ ### Configuration
19
25
 
26
+ 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.
20
27
 
21
28
  ### Running
22
29
 
23
- ```
24
- $ pnpm dev
30
+ ```sh
31
+ $ pnpm start
25
32
  ```
26
33
 
27
34
  Maps can then be viewed at http://localhost:3000.
28
35
 
36
+ ---
29
37
 
30
- ### Configuration
31
-
32
- 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.
33
-
34
- ## Documentation
38
+ ## Example usage
35
39
 
36
- The API is documented at `Read the Docs <https://flatmap-viewer.readthedocs.io/en/mapmaker-v2/>`.
40
+ See [here](https://anatomicmaps.github.io/flatmap-viewer/documents/HowTo_Guide.html)