wwt-website/README.md

AAS WorldWide Telescope website

This repository contains the code for the web services backing the AAS WorldWide Telescope (WWT) software system.

Developer Instructions

See these instructions for details on how to build and run locally. Please submit issues (or PRs!) if you run into any problems or inaccuracies.

If you have .NET 6 installed, the basic CLI build command is:

dotnet build -c Release wwt-website-net6.slnf

You can build and run the server in a Docker container with:

docker build -t aasworldwidetelescope/core-data:latest .
docker run --rm -p 8080:80 --name wwtcoredata aasworldwidetelescope/core-data:latest
# browse to http://localhost:8080/wwtweb/isstle.aspx

However, most API endpoints won't work since they need to be wired up to the backing data storage. To test locally with WWT production assets, launch the Docker container with the following environment variables:

-e UseAzurePlateFiles=true -e AzurePlateFileStorageAccount=[secret]

where the secret can be obtained from the running app's configuration KeyVault.

See comments in the azure-pipelines.yml file for descriptions of how deployment works.

This file logs old APIs that have been deprecated or removed. The implementations of many of these can be found in the Git history if you’re willing to dig.

Getting involved

We love it when people get involved in the WWT community! You can get started by participating in our user forum or by signing up for our low-traffic newsletter. If you would like to help make WWT better, our Contributor Hub aims to be your one-stop shop for information about how to contribute to the project, with the Contributors’ Guide being the first thing you should read. Here on GitHub we operate with a standard fork-and-pull model.

All participation in WWT communities is conditioned on your adherence to the WWT Code of Conduct, which basically says that you should not be a jerk.

Acknowledgments

The AAS WorldWide Telescope system is a .NET Foundation project. Work on WWT has been supported by the American Astronomical Society (AAS), the US National Science Foundation (grants 1550701, 1642446, and 2004840), the Gordon and Betty Moore Foundation, and Microsoft.

Legalities

The WWT code is licensed under the MIT License. The copyright to the code is owned by the .NET Foundation.