https://github.com/ssciwr/iwr-interactive-visualization
Interactive visualization of the IWR
https://github.com/ssciwr/iwr-interactive-visualization
iwr research svg typescript visualization
Last synced: about 1 month ago
JSON representation
Interactive visualization of the IWR
- Host: GitHub
- URL: https://github.com/ssciwr/iwr-interactive-visualization
- Owner: ssciwr
- Created: 2021-12-17T12:41:34.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-01T04:22:44.000Z (about 2 months ago)
- Last Synced: 2025-04-01T05:25:22.072Z (about 2 months ago)
- Topics: iwr, research, svg, typescript, visualization
- Language: TypeScript
- Homepage: https://ssciwr.github.io/iwr-interactive-visualization/
- Size: 40.7 MB
- Stars: 0
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [ssciwr.github.io/iwr-interactive-visualization](https://ssciwr.github.io/iwr-interactive-visualization/)
[](https://github.com/ssciwr/iwr-interactive-visualization/actions/workflows/deploy.yml)
An interactive visualization of the IWR and its activities
## Overview
Implemented in javascript and SVG using [svg.js](https://svgjs.dev/)
- [main](https://github.com/ssciwr/iwr-interactive-visualization/tree/main) branch contains the source code
- contents can be edited in [src/data/data.json](https://github.com/ssciwr/iwr-interactive-visualization/blob/main/src/data/data.json)
- [gh-pages](https://github.com/ssciwr/iwr-interactive-visualization/tree/gh-pages) branch contains the generated website
- uses [npm](https://www.npmjs.com/) and [webpack](https://webpack.js.org/) to manage the build and dependencies
## Online preview
On every commit to the main branch:
- [deploy.yml](https://github.com/ssciwr/iwr-interactive-visualization/actions/workflows/deploy.yml) action builds website & deploys to the [gh-pages](https://github.com/ssciwr/iwr-interactive-visualization/tree/gh-pages) branch
- github pages hosts these files at [ssciwr.github.io/iwr-interactive-visualization](https://ssciwr.github.io/iwr-interactive-visualization/)
## How to deploy
- [download a zipfile](https://github.com/ssciwr/iwr-interactive-visualization/archive/refs/heads/gh-pages.zip) of the files in the [gh-pages](https://github.com/ssciwr/iwr-interactive-visualization/tree/gh-pages) branch
- contents can be edited in [data.json](https://raw.githubusercontent.com/ssciwr/iwr-interactive-visualization/gh-pages/fileadmin/templates/iwr_vis/data.json)
- to change the location of the image files
- edit [image_base_url](https://github.com/ssciwr/iwr-interactive-visualization/blob/gh-pages/fileadmin/templates/iwr_vis/data.json#L2)
- to change the location of data.json
- find `"fileadmin/templates/iwr_vis/data.json"` in [bundle.js](https://github.com/ssciwr/iwr-interactive-visualization/blob/gh-pages/bundle.js) and replace with desired url
## How to build and view locally
Initial setup:
- clone this repo
- `git clone https://github.com/ssciwr/iwr-interactive-visualization.git`
- `cd iwr-interactive-visualization`
- (optional) install pre-commit to auto-format code
- `pip install pre-commit`
- `pre-commit install`
- install [pnpm](https://pnpm.io/installation)
- windows: `iwr https://get.pnpm.io/install.ps1 -useb | iex`
- linux/macOS: `curl -fsSL https://get.pnpm.io/install.sh | sh -`
- install website dependencies
- `pnpm install`
To build from source, start local http-server, open website in browser, monitor & re-build modified source files:
- `pnpm start`
Other commands:
- remove any existing build
- `pnpm run clean`
- build website in `dist` folder
- `pnpm run build`
- start a http-server serving files from the `dist` folder at `http://localhost:8080/` & open in browser
- `pnpm run serve`
- monitor changes to source code & automatically re-build modified files
- `pnpm run autobuild`