diff --git a/README.md b/README.md index 9e0abeec2426929b8def7a8f5b5f4434967fff4d..3448c2f3dca1c4d845dd3ce029257954a72ce87a 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,11 @@ Copyright 2020-2021, Forschungszentrum Jülich GmbH ## Getting Started -A live version of the Interactive Atlas Viewer is available at [https://interactive-viewer.apps.hbp.eu](https://interactive-viewer.apps.hbp.eu). This section is useful for developers who would like to develop this project. +A live version of the Interactive Atlas Viewer is available at [https://atlases.ebrains.eu/viewer/](https://atlases.ebrains.eu/viewer/). This section is useful for developers who would like to develop this project. ### General information -Interactive atlas viewer is built with [Angular (v12.0)](https://angular.io/), [Bootstrap (v4)](http://getbootstrap.com/), and [fontawesome icons](https://fontawesome.com/). Some other notable packages used are [ngrx/store](https://github.com/ngrx/platform) for state management. +Interactive atlas viewer is built with [Angular (v13.0)](https://angular.io/), [Bootstrap (v4)](http://getbootstrap.com/), and [fontawesome icons](https://fontawesome.com/). Some other notable packages used are [ngrx/store](https://github.com/ngrx/platform) for state management. Releases newer than [v0.2.9](https://github.com/HumanBrainProject/interactive-viewer/tree/v0.2.9) also uses a nodejs backend, which uses [passportjs](http://www.passportjs.org/) for user authentication, [express](https://expressjs.com/) as a http framework. @@ -25,7 +25,7 @@ Releases newer than [v0.2.9](https://github.com/HumanBrainProject/interactive-vi #### Prerequisites -- latest version of node 12.x.x or node 14.x.x +- node 12.20.0 or later #### Environments @@ -48,8 +48,8 @@ Please see [e2e_env.md](e2e_env.md) To run a dev server, run: ```bash -$ git clone https://github.com/HumanBrainProject/interactive-viewer -$ cd interactive-viewer +$ git clone https://github.com/FZJ-INM1-BDA/siibra-explorer +$ cd siibra-explorer $ npm i $ npm run dev-server ``` @@ -69,51 +69,7 @@ $ npm run build-aot ### Develop plugins -Below demonstrates an example workflow for developing plugins: - -```bash - -$ # build aot version of the atlas viewer -$ npm run build-aot -$ cd deploy -$ # run server with PLUGIN_URLS -$ PLUGIN_URLS=http://localhost:3333/manifest.json;http://localhost:3334/manifest.json node server.js -``` - -Interactive Atlas Viewer attempts to fetch list of manifests: - -``` -GET {BACKEND_URL}/plugins -``` - -The response from this endpoint will be: - -```json -[ - "http://localhost:3333/manifest.json", - "http://localhost:3334/manifest.json" -] -``` - -When user launches the viewer, the atlas viewer will attempt to fetch the metadata of the plugins: - -``` -GET http://localhost:3333/manifest.json -GET http://localhost:3334/manifest.json -``` - -The response from these endpoints are expected to adhere to [manifests](src/plugin_examples/README.md#Manifest%20JSON). - -When the user launches the plugin, the viewer will fetch `templateUrl` and `scriptUrl`, if necessary. - -Plugin developers can start their own webserver, use [interactive-viewer-plugin-template](https://github.com/HumanBrainProject/interactive-viewer-plugin-template), or (coming soon) provide link to a github repository. - - -[plugin readme](src/plugin_examples/README.md) - -[plugin api](src/plugin_examples/plugin_api.md) - -[plugin migration guide](src/plugin_examples/migrationGuide.md) +Please see [src/plugin/README.md](src/plugin/README.md) ## Contributing @@ -121,7 +77,7 @@ Feel free to raise an issue in this repo and/or file a PR. ## Versioning -Commit history prior to v0.2.0 is available in the [legacy-v0.2.0](https://github.com/HumanBrainProject/interactive-viewer/tree/legacy-v0.2.0) branch. The repo was rewritten to remove its dependency on neuroglancer and nehuba. This allowed for simpler webpack config, faster build time and AOT compilation. +Commit history prior to v0.2.0 is available in the [legacy-v0.2.0](https://github.com/FZJ-INM1-BDA/siibra-explorer/tree/legacy-v0.2.0) branch. The repo was rewritten to remove its dependency on neuroglancer and nehuba. This allowed for simpler webpack config, faster build time and AOT compilation. ## License diff --git a/package-lock.json b/package-lock.json index 91c0557129cd3a6dae60b6bd0036c32bb5506f80..7e45c2495bfb1aebc9be07a2c5843a748cb988b6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1479,12 +1479,12 @@ } }, "@angular/cdk": { - "version": "12.2.13", - "resolved": "https://registry.npmjs.org/@angular/cdk/-/cdk-12.2.13.tgz", - "integrity": "sha512-zSKRhECyFqhingIeyRInIyTvYErt4gWo+x5DQr0b7YLUbU8DZSwWnG4w76Ke2s4U8T7ry1jpJBHoX/e8YBpGMg==", + "version": "13.3.4", + "resolved": "https://registry.npmjs.org/@angular/cdk/-/cdk-13.3.4.tgz", + "integrity": "sha512-im4LKxJaIuqFVzmtf650PoiYsn/SZlvBV2zEgzusK8HwQ24C1Lya7NQSApwl8k43h4eKO1OvUKBjqL5uDgEQag==", "requires": { "parse5": "^5.0.0", - "tslib": "^2.2.0" + "tslib": "^2.3.0" } }, "@angular/cli": { @@ -1692,11 +1692,11 @@ } }, "@angular/material": { - "version": "12.2.13", - "resolved": "https://registry.npmjs.org/@angular/material/-/material-12.2.13.tgz", - "integrity": "sha512-6g2GyN4qp2D+DqY2AwrQuPB3cd9gybvQVXvNRbTPXEulHr+LgGei00ySdFHFp6RvdGSMZ4i3LM1Fq3VkFxhCfQ==", + "version": "13.3.4", + "resolved": "https://registry.npmjs.org/@angular/material/-/material-13.3.4.tgz", + "integrity": "sha512-jK9rWmBaPrE+3re6uIdyvG5DCzc47VUvnP1DqblNnpaa8GCKllb1cFRGqa5GPYB1/96d3wO+RPwzhC06qqV+yw==", "requires": { - "tslib": "^2.2.0" + "tslib": "^2.3.0" } }, "@angular/platform-browser": { diff --git a/package.json b/package.json index 3c778a21a854397dd05f54dfcc177d9222096780..ba605426618c63d8787644a6e0dcb62870cbac9e 100644 --- a/package.json +++ b/package.json @@ -57,12 +57,12 @@ }, "dependencies": { "@angular/animations": "~13.3.4", - "@angular/cdk": "^12.2.2", + "@angular/cdk": "^13.3.4", "@angular/common": "~13.3.4", "@angular/compiler": "~13.3.4", "@angular/core": "~13.3.4", "@angular/forms": "~13.3.4", - "@angular/material": "^12.2.2", + "@angular/material": "^13.3.4", "@angular/platform-browser": "~13.3.4", "@angular/platform-browser-dynamic": "~13.3.4", "@angular/router": "~13.3.4", diff --git a/src/theme.scss b/src/theme.scss index 6f0dcf85a110b9d810a7fd9f681f0c791f059783..8140e544fe37b55173fc22cc6b374c5e559ad2b4 100644 --- a/src/theme.scss +++ b/src/theme.scss @@ -1,5 +1,5 @@ @use 'sass:map'; -@use '~@angular/material' as mat; +@use '@angular/material' as mat; @include mat.core();