search

USGS-WiM / SiGLDMS

Data management system for SiGL
Other
0 stars 5 forks source link

readme

WiM

SigL Data Management System

Data Management System for the USGS Science in the Great Lakes (SiGL) mapper.

Prerequisites

required software

node.js
git

Install global dependencies

npm install -g bower
npm install -g gulp

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.

Installing

https://help.github.com/articles/cloning-a-repository/

Inside of your project folder (after git fork and clone):

npm install
bower install

Troubleshooting dependencies

updated for 2021: this project uses npm shrinkwrap to freeze dependencies of dependencies in the tree. the npm-shrinkwrap.json file shipped with this code will supercede the package.json. If the app fails to build try replacing the contents of the npm-shrinkwrap.json with the following

{
  "dependencies": {
    "graceful-fs": {
        "version": "4.2.2"
     }
  }
}

Then run npm install

Building and testing

To run the debugging 'watch' script for this repo, run 'gulp watch-dev'

Deployment

'gulp build-app-dev' will build a dev folder 'gulp build-app-prod' will build a dist folder

Built With

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

Acknowledgments

About WIM