VisAO is a web application that simplifies data visualization using the new Adaptive Optics Telemetry Standard (AOT).
To run VisAO locally you'll need Docker, you can search on how to install it on your OS but we recommend Docker Desktop for ease of use, and it is supported on all major OSes.
After installing you can clone this repository using this command:
git clone https://github.com/LuisDuarte1/VisAO.gitAfter switching to the VisAO directory you can run it using:
docker compose -f docker-compose-prod.yaml up -dYou can now, open it in a browser using this URL: http://localhost:4000
Note
VisAO will continue to run indefinitely on the background, and will probably hog your resources. You can shut it down by closing Docker Desktop if you have it, on macOS, or by running the down command:
docker compose -f docker-compose-prod.yaml downData will be stored inside the repository in the visao/ folder.
You can reuse the docker-compose-prod.yaml file, but please change the database credentials before deploying it. It's recommended to only deploy it onto a local network because VisAO needs high connection speeds to be smoother.
Warning
You should change the .env.docker file into the public URL, so that, the frontend-backend communication works, before deploying it. You will need to build a new VisAO custom image for that.
Caution
VisAO has no authentication methods, and therefore you should NOT expose it into the internet, VisAO is not tested or supported for that.
To develop, use the provided docker-compose.yaml file, which separates the backend and the frontend and enables watching to enable a smoother developer experience.
Note
If you add dependencies either on the frontend or the backend you must rebuild the images by running:
docker compose buildOn the frontend (assuming you are in the frontend directory):
npm run proto:buildOn the backend (assuming you are in the backend directory and you are on a system running a POSIX shell):
./generate_proto.sh