Skip to content

Flood inundation map libraries with real-time USGS river-level data.

License

Notifications You must be signed in to change notification settings

USGS-WiM/fim-js

Repository files navigation

WiM

Deploy to test.wim.usgs.gov/fim

Flood Inundation Mapper

The Flood Inundation Mapper to explore flood inundation maps, streamflow conditions, flood forecasts, potential loss estimates, and more.

Prerequisites

Node Package Manager (npm)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

run npm install AND bower install to get dependencies after first cloning

gulp watch to run in browser with watch for debugging

gulp to build project

gulp serve-build to serve from the /build/ folder

Built With

  • NPM - Dependency Management
  • gulp - Build system and task runner

Contributing

Please read CONTRIBUTING.md for details on the process for submitting pull requests to us. Please read CODE_OF_CONDUCT.md for details on adhering by the USGS Code of Scientific Conduct.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Advance the version when adding features, fixing bugs or making minor enhancement. Follow semver principles. To add tag in git, type git tag v{major}.{minor}.{patch}. Example: git tag v2.0.5

To push tags to remote origin: git push origin --tags

*Note that your alias for the remote origin may differ.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the Creative Commons CC0 1.0 Universal License - see the LICENSE.md file for details

Suggested Citation

In the spirit of open source, please cite any re-use of the source code stored in this repository. Below is the suggested citation:

This project contains code produced by the Web Informatics and Mapping (WiM) team at the United States Geological Survey (USGS). As a work of the United States Government, this project is in the public domain within the United States. https://wim.usgs.gov

About WIM

  • This project authored by the USGS WIM team
  • WIM is a team of developers and technologists who build and manage tools, software, web services, and databases to support USGS science and other federal government cooperators.
  • WIM is a part of the Upper Midwest Water Science Center.