Skip to content

mark-nicol/observation-tool-client

Repository files navigation

ALMA Design Study Prototype Web Application

The ALMA Observing Tool (OT) is an application for the used for the preparation and submission of ALMA Phase 1 (observing proposal) and Phase 2 (telescope runfiles for accepted proposals) materials. The present ALMA-OT is a desktop Java application, running (almost) wholly on the users own machine.The exceptions are when submitting/retrieving proposals and when querying external databases and archives (such as name resolvers and image servers).

This application is a prototype of the proposed upgraded OT. Built using Angular, it moves heavy weight processes to a backend built using microservice architecture (see the microservices repository) in an effort to reduce the requirements of the client system and increase mobility.

Usage (Development)

Prerequisites

This web app requires:

It's recommended you clone and run the backend services before the web application.

Process

Clone the repository

Navigate into the repo

cd observation-tool-client

Install required modules

npm install

Run the development server

npm run ng serve

Open you browser of choice and navigate to

http://localhost:4200

Documentation

For documentation, visit almaobservationtoolstudy.bitbucket.io

Generating Documentation

To generate documentation ensure this repository and the documentation repository are cloned and in the same parent folder, i.e.:

  parent/
  ├──── app-repo/
  |     └── <app-files>
  └──── docs-repo/
        └── <docs-files>

In the app repository, run the compodoc script from package.json

npm run compodoc

This will create documentation in the docs repository

Then commit and push the new docs

cd ../almaobservationtoolstudy.bitbucket.io
git add .
git commit -m "<message>"
git push origin master

Writing Documentation

Compodoc provides support for some JSDoc tags, more info here.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •