owf-app-snodas-ng

Open Water Foundation Snow Data Assimilation System (SNODAS) data viewing web application.

Introduction
Repository Contents
Getting Started
Running the Application
Troubleshooting
Maintainers
Contributors
License
Resources

Introduction

This repository contains files for developing and deploying the OWF SNODAS application, developed using the Angular web framework.

This is an Angular version of the CDSS SNODAS Tools software, which improves on the original version: standard development environment, better layout management, object-oriented programming with TypeScript, support for mobile devices, automated testing, ect. This version is intended to be an option for applications outside of the original implementation for the State of Colorado.

It is also an updated version of the Old CDSS SNODAS Tools that updates the application from Angular 8 to Angular 11, and replaces HTML 5 code with Angular based components, data binding, interpolation, etc.

Repository Contents

The following folder structure is recommended for development. Top-level folders should be created as necessary. The following folder structure clearly separates user files (as per operating system), development area (owf-dev), product (SNODAS), repositories for product (git-repos), and specific repositories for the product. Repository folder names should agree with GitHub repository names. Scripts in repository folders that process data should detect their starting location and then locate other folders using relative paths, based on the following convention.

C:\Users\user\                              User's home folder for Windows.
/c/Users/user/                              User's home folder for Git Bash.
/cygdrive/C/Users/user/                     User's home folder for Cygwin.
/home/user/                                 User's home folder for Linux.
  owf-dev/                                  Work done on Open Water Foundation projects.
    SNODAS/                                 SNODAS product files.
      ---- below here folder names should match exactly ----
      git-repos/                            Git repositories for InfoMapper.
        owf-app-snodas-ng/                  Angular SNODAS web application.

This repository contains the following:

owf-app-snodas-ng/
  build-util/                               Scripts to manage repository, as needed.
  snodas-workspace/                         Top-level folder for the Angular workspace.
    projects/                               Holds all projects in the workspace. (apps, libraries)
      snodas/                               SNODAS source and testing code.
  .git                                      Standard Git software folder for repository (DO NOT TOUCH).
  .gitattributes                            Standard Git configuration file for repository (for portability).
  .gitignore                                Standard Git configuration file to ignore dynamic files.
  README.md                                 This README file.

Getting Started

Development and deployment of this angular based web application requires the following tools:

Node.js - To install, go to the Node.js website.
npm - npm is automatically installed with Node.js. To check what version of npm is installed run npm -v. To update npm run npm install npm@latest -g.
Angular CLI - To check what version is installed run ng --version. If Angular CLI needs installed run npm install -g @angular/cli.

Running the Application

To run the application locally, such as during development:

Open a Linux shell (ex. Git Bash, Cygwin).
cd to the snodas-workspace/projects/snodas/ folder.
Update the Angular packages and dependencies by running npm install.
Serve the application using a local web server and open browser window by running ng serve --open.
Use CTRL-c to kill the local server.

Troubleshooting

npm installing

Dealing with npm and GitHub has not always gone smoothly. Sometimes there are issues when npm is looking at the wrong registry, or npm updates happen for major releases. This section covers some of these instances and contains fixes/help for resolving them.

npm resets registry

Even after using the npm config set registry <registry-url>, running npm install errors, and a npm config get registry returns a different registry. I believe the issue is an update to npm. The .npmrc file configuration has changed, so where it used to contain:

registry=https://npm.pkg.github.com/OpenWaterFoundation

It is now:

@OpenWaterFoundation:registry=https://npm.pkg.github.com

I think the old way of configuring the .npmrc files was setting the entire registry to the OpenWaterFoundation, so npm was trying to fetch all files from there. The error thrown when npm install failed looked like this:

npm install registry error

Updating the .npmrc file resolved the issue.

OpenWaterFoundation / owf-app-snodas-ng

readme