Skip to content

TACC-Cloud/hazmapper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

f96b7aa · Feb 20, 2025
Jan 15, 2025
Dec 9, 2024
Feb 20, 2025
Jan 18, 2024
Jan 15, 2025
Jan 10, 2025
Dec 6, 2024
Jan 18, 2024
Oct 18, 2024
Oct 4, 2019
Mar 2, 2023

Repository files navigation

Hazmapper

Hazmapper is an application for creating, visualizing, and analyzing geospatial data in a variety of formats.

See https://github.com/TACC-Cloud/geoapi which is an associated restful API.

Local React Development

react/ directory contains the React client

To get started, create a local secret file for local development:

cp react/src/secret_local.example.ts react/src/secret_local.ts

The geoapiBackend setting in react/src/secret_local.ts ( see the example react/src/secret_local.example.ts ) controls which backend GeoAPI is used by Hazmapper during local development. You can choose from the following:

  • EnvironmentType.Production
  • EnvironmentType.Staging
  • EnvironmentType.Dev
  • EnvironmentType.Local

To run Hazmapper with the GeoAPI backend locally, configure geoapiBackend to use GeoapiBackendEnvironment.Local and see the GeoAPI repository for more detailed instructions.

Run

npm ci
npm run dev

Navigate to http://localhost:4200/.

Running unit tests

Run npm run test

Running linters

Run npm run lint to run linter

Run npm run lint:fix to fix any linting/prettier errors

Local Angular Development

angular/ has the angular client

Two ways to run a dev server:

  • npm run start:local. Navigate to http://hazmapper.local:4200/. (Note that hazmapper.local needs to be added to your /etc/hosts)
  • npm run start. Navigate to http://localhost:4200/.

The app will automatically reload if you change any of the source files.

Configuring which geoapi-backend is used

The backend in angular/src/environments/environment.ts can be used to select which backend geoapi is used by the app:

  • EnvironmentType.Production
  • EnvironmentType.Staging
  • EnvironmentType.Local*

*See https://github.com/TACC-Cloud/geoapi for more details on running geoapi locally.

Running unit tests

Run npm run test to execute the unit tests via Karma.

Running linters

Run npm run lint to run all of the linters.

Run npm run lint:js to run linter for angular files. Run npm run lint:css to run linter for css files.

Run npm run lint:js -- --fix to fix angular files. Run npm run lint:css -- --fix to fix css files.

Code scaffolding

Run ng generate component components/component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Deployment

For deployment information, see https://github.com/TACC-Cloud/geoapi/blob/master/devops/README.md