WorldWide Telescope Constellations: The Frontend

This is a web application built on Nuxt. Look at the Nuxt 3 documentation to learn more.

In order to be fully operable, this server must be able to communicate with a Constellations backend server (location configurable with the NUXT_PUBLIC_API_URL environment variable) and a Keycloak server (location configurable with NUXT_PUBLIC_KEYCLOAK_URL). The backend, in turn, needs to be able to communicate with a MongoDB server (or something compatible).

Setup

Make sure to install the dependencies:

yarn install

Development Server

Start the development server on http://localhost:3000:

yarn dev

Production

Build the application for production:

yarn build

Locally preview production build:

yarn preview

Check out the deployment documentation for more information.

Configuration

Environment variables:

NUXT_PUBLIC_API_URL to set the URL to the backend API server; default is http://localhost:7000
NUXT_PUBLIC_GOOGLE_ANALYTICS_TAG to set the tag (of the form G-XXXXXXXXXX) used for Google Analytics telemetry. If left unset, the telemetry is disabled.
NUXT_PUBLIC_HOST_URL to specify the base URL of this server's public frontend; default is http://localhost:3000. While most internal URLs are relative, this setting is used to construct canonical URLs when they are needed (e.g., social sharing headers). This value should not end in a slash.
NUXT_PUBLIC_KEYCLOAK_URL to set the URL to the Keycloak instance; default is http://localhost:8080/

Setting up a Development Environment

See the wwt-constellations-backend README for detailed instructions on setting up the necessary services for local testing. If you use the default values there, a simple yarn dev should get things going for you here.

Deployment

Merges to the main branch are automatically deployed to a “staging slot” of the WWT web app. To bring the new code into production, you need to “swap” that slot into the production role. You can do this through the Azure Portal UI or using the az CLI tool as follows:

az webapp deployment slot swap -g wwtprod-cxbackend -n wwtprod-cxfe --slot stage --target-slot production

(Yes, the resource group name with backend is correct here.)

Color Theme

These are the colors associated with the Naive UI dark theme used by the app. If you copy-paste this chunk of code into a CSS style block, your editor might show you previews of the various colors.

.palette {
    /* primary: hover, default, active, suppl */
    color: #7fe7c4;
    color: #63e2b7;
    color: #5acea7;
    color: #2a947d;

    /* info: hover, default, active, suppl, my darkened variant */
    color: #8acbec;
    color: #70c0e8;
    color: #66afd3;
    color: #3889c5;
    color: #215276;

    /* error: hover, default, active, suppl */
    color: #e98b8b;
    color: #e88080;
    color: #e57272;
    color: #d03a52;

    /* warning: hover, default, active, suppl */
    color: #f5d599;
    color: #f2c97d;
    color: #e6c260;
    color: #f08a00;

    /* success: hover, default, active, suppl */
    color: #7fe7c4;
    color: #63e2b7;
    color: #5acea7;
    color: #2a947d;

    /* Gray/blacks for backgrounds */
    color: #48484e;
    color: #2c2c32;
    color: #18181c;
    color: #101014;
}

WorldWideTelescope/wwt-constellations-frontend