@loveluthien/carta-frontend 6.0.0-dev

package/README.md

@@ -0,0 +1,112 @@
+# CARTA Frontend
+The CARTA frontend is used in conjunction with the [CARTA backend](https://github.com/CARTAvis/carta-backend), and for general use a pre-built production frontend is usually installed alongside the backend automatically. However, a user may wish to install the frontend component separately in order to test beta versions, for example, or to develop it.
+
+## Pre-built production packages
+The simplest way to install the frontend component is to use the pre-built production packages from NPM (for any OS with Node.js installed), our PPA (Debian packages for Ubuntu), or our RPM repository (for RHEL based systems).
+
+### NPM
+
+Pre-built production frontends can be obtained from the [npmjs.com carta-frontend repository](https://www.npmjs.com/package/carta-frontend?activeTab=explore).
+
+If you have Node.js and `npm` already installed on your system, you can install a production frontend using the following command:
+
+```
+npm i carta-frontend
+```
+The files will be installed to your `node-modules` directory. For a system-wide 'global' installation (using the `-g` flag) this is located at `/usr/lib/node_modules`, whereas for a local user installation, it is located at `$PWD/node_modules`.
+
+You can install specific frontend versions by appending `@` plus the version number. For example,
+```
+npm i carta-frontend@4.1.0
+npm i carta-frontend@5.0.0-beta.1c
+```
+The available versions are listed in the [npmjs.com carta-frontend versions tab](https://www.npmjs.com/package/carta-frontend?activeTab=versions).
+
+Alternatively, the pre-built production frontend can be downloaded directly without npm. For example,
+```
+wget https://registry.npmjs.org/carta-frontend/-/carta-frontend-5.0.0.tgz
+```
+The standalone `tgz` archive file extracts as `package/build` in your current directory.
+
+You can start the CARTA backend with a non-default frontend by specifying its location with the `--frontend_folder` flag. For example,
+```
+./carta-backend --frontend_folder $HOME/package/build
+```
+
+### PPA
+
+A Personal Package Archive (PPA) is a third-party package repository for Ubuntu. We supply pre-built production frontends at the [CARTAvis-team PPA on the Ubuntu Lauchpad](https://launchpad.net/~cartavis-team/+archive/ubuntu/carta).
+
+To install the latest release version:
+```
+sudo add-apt-repository ppa:cartavis-team/carta
+sudo apt-get update
+sudo apt-get install carta-frontend
+```
+
+The Ubuntu package install location for the frontend is `/usr/share/carta/frontend/`.
+
+The PPA also provides a `carta` metapackage which automatically installs the CARTA frontend and backend packages. In addition to the latest release versions, beta versions are provided in a parallel set of packages.
+
+
+### RPM
+
+RPMs are for users of Red Hat Enterprise Linux (RHEL) and other Red Hat-based Linux distributions, e.g. CentOS. 
+To install the latest release version, add the appropriate repository file depending on whether you are using RHEL8 (**el8**) or RHEL9 (**el9**):
+
+```
+sudo curl https://packages.cartavis.org/cartavis-el8.repo --output /etc/yum.repos.d/cartavis.repo
+```
+or
+```
+sudo curl https://packages.cartavis.org/cartavis-el9.repo --output /etc/yum.repos.d/cartavis.repo
+```
+Then the frontend component can be installed using `dnf` or `yum`:
+```
+sudo dnf install carta-frontend
+```
+The RPM package install location for the frontend is `/usr/share/carta/frontend/`.
+
+The RPM repo also provides a `carta` metapackage which automatically installs the CARTA frontend and backend packages. In addition to the latest release versions, beta versions are provided in a parallel set of packages.
+
+
+## Development
+
+If you wish to modify or develop the CARTA frontend, you may build a production or non-production frontend from source. Here are the instructions to do so:
+
+### Prerequisites
+
+The build process relies heavily on `npm` and `nodejs`, so make sure they are installed and accessible.
+
+We recommend using [Docker](https://www.docker.com) or [Singularity](https://apptainer.org/docs/) to perform WebAssembly compilation. If neither is available, the Emscripten compiler (`emcc` version 4.0.3 recommended) needs to be available in the build environment. Installation instructions are available on the [Emscripten homepage](https://emscripten.org/docs/getting_started/downloads.html).
+
+### Build process (using Docker/Singularity)
+Initialise submodules and install package dependencies:
+```
+git submodule update --init --recursive
+npm install
+```
+WebAssembly libraries can be built with `npm run build-libs-docker` or `npm run build-libs-singularity`.
+Additional build steps (building WebAssembly wrappers, protocol buffer modules and compiling the Typescript code) are performed by `npm run build-docker` or `npm run build-singularity`. This produces a production build in the `build` folder.
+
+To run a development build server, simply run `npm run start`. 
+
+### Build process (without Docker/Singularity)
+If your build environment does not have access to Docker or Singularity, WebAssembly compilation must be performed in an environment with access to the Emscripten compiler. 
+
+Initialise submodules and install package dependencies:
+```
+git submodule update --init --recursive
+npm install
+```
+
+WebAssembly libraries can be built with `npm run build-libs`.
+Additional build steps (building WebAssembly wrappers, protocol buffer modules and compiling the Typescript code) are performed by `npm run build`. This produces a production build in the `build` folder.
+
+To run a development build server, simply run `npm run start`.
+
+## Developer documentation
+
+Automatically generated documentation can be found at [cartavis.org/carta-frontend](https://cartavis.org/carta-frontend/).
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3377984.svg)](https://doi.org/10.5281/zenodo.3377984)

package/babel.config.json

@@ -0,0 +1,10 @@
+{
+  "presets": [
+    ["@babel/preset-env", { "targets": { "node": "current" } }],
+    ["@babel/preset-react", { "runtime": "automatic" }],
+    "@babel/preset-typescript"
+  ],
+  "plugins": [
+    ["@babel/plugin-proposal-decorators", { "legacy": true }]
+  ]
+}

package/build/index.html

@@ -0,0 +1,147 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <meta name="theme-color" content="#000000">
+    <link rel="manifest" href="./manifest.json">
+    <link rel="shortcut icon" href="./carta_icon_128px.png">
+    <title>CARTA</title>
+    <style>
+        .static-text {
+            font-size: 14px;
+            font-weight: 400;
+            letter-spacing: 0;
+            line-height: 1.28581;
+            text-transform: none;
+            color: #182026;
+            font-family: -apple-system, "BlinkMacSystemFont", "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Open Sans", "Helvetica Neue", "Icons16", sans-serif;
+        }
+
+        .static-pre {
+            color: #182026;
+            font-size: 14px;
+            white-space: pre-line;
+        }
+
+        .static-overlay {
+            position: absolute;
+            top: 0;
+            bottom: 0;
+            left: 0;
+            right: 0;
+            margin: auto;
+            height: 400px;
+            width: 650px;
+        }
+
+        .loading-div {
+            width: 650px;
+            height: 400px;
+            background: #f5f8fa;
+            text-align: center;
+            padding: 15px;
+            box-shadow: 0 0 0 1px rgba(16, 22, 26, 0.1), 0 4px 8px rgba(16, 22, 26, 0.1), 0 18px 46px 6px rgba(16, 22, 26, 0.1);
+            border-radius: 6px;
+            border: 2px solid #5480b7;
+            box-sizing: border-box;
+        }
+
+        .static-spinner {
+            align-items: center;
+            display: flex;
+            justify-content: center;
+            vertical-align: middle;
+            margin: 20px;
+        }
+
+        .static-spinner-animation {
+            width: 30px;
+            height: 30px;
+            animation: static-spinner-animation .5s linear infinite;
+        }
+
+        @keyframes static-spinner-animation {
+            from {
+                -webkit-transform: rotate(0deg);
+                transform: rotate(0deg);
+            }
+            to {
+                -webkit-transform: rotate(360deg);
+                transform: rotate(360deg);
+            }
+        }
+
+        .static-spinner-track {
+            fill-opacity: 0;
+            stroke: rgba(92, 112, 128, .2);
+            stroke-width: 8px;
+        }
+
+        .static-spinner-head {
+            fill-opacity: 0;
+            stroke: rgba(43, 149, 214, .8);
+            stroke-width: 13px;
+        }
+
+        .loading-text {
+            animation: cssAnimation 5s forwards;
+            opacity: 0;
+        }
+
+        @keyframes cssAnimation {
+            0% {
+                opacity: 0;
+            }
+            90% {
+                opacity: 0;
+            }
+            100% {
+                opacity: 1;
+            }
+        }
+    </style>
+<script defer src="./static/js/546.b5841ade.js"></script><script defer src="./static/js/index.8fc34b4d.js"></script><link href="./static/css/546.aa44a897.css" rel="stylesheet"><link href="./static/css/index.c1f77b92.css" rel="stylesheet"></head>
+<body>
+<noscript>
+    You need to enable JavaScript to run this app.
+</noscript>
+<div id="root">
+    <div class="static-overlay">
+        <div class="loading-div">
+            <img src="./carta_logo.png" width="150" height="175" alt="CARTA">
+            <div class="static-spinner">
+                <div class="static-spinner-animation">
+                    <svg width="30" height="30" viewBox="-1.67 -1.67 103.33 103.33">
+                        <path
+                                class="static-spinner-track"
+                                d="M 50,50 m 0,-45 a 45,45 0 1 1 0,90 a 45,45 0 1 1 0,-90"
+                        />
+                        <path
+                                class="static-spinner-head"
+                                d="M 50,50 m 0,-45 a 45,45 0 1 1 0,90 a 45,45 0 1 1 0,-90"
+                                pathLength="280"
+                                stroke-dasharray="280 280"
+                                stroke-dashoffset="210"
+                        />
+                    </svg>
+                </div>
+            </div>
+            <div class="loading-text">
+                <p class="static-text">
+                    Loading CARTA. If this message does not disappear, please
+                    <a href="https://refreshyourcache.com/en/cache/">hard-reload</a>
+                    this site in your browser using the shortcut below:
+                </p>
+                <pre class="static-pre">
+                macOS : option + command + R (Safari)
+                macOS : shift + command + R (Chrome, Firefox)
+                Linux : shift + control + R
+                Windows : control + F5
+            </pre>
+            </div>
+        </div>
+    </div>
+</div>
+</body>
+</html>

package/build/manifest.json

@@ -0,0 +1,15 @@
+{
+  "short_name": "CARTA",
+  "name": "CARTA Frontend",
+  "icons": [
+    {
+      "src": "carta_icon_128px.png",
+      "sizes": "128x128",
+      "type": "image/png"
+    }
+  ],
+  "start_url": "./index.html",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}

package/build/robots.txt

@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow: