Update, 2024-03-15: Deprecated
This repository has been has moved to a different hosting platform and is no longer being actively maintained. Please see StreamStats Repository for latest updates related to this effort.
StreamStats client application
Install global dependencies
npm install -g gulp
npm install -g typings
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.
Clone the repository (https://help.github.com/articles/cloning-a-repository/)
git clone https://github.com/USGS-WiM/StreamStats
Inside of your project folder (after clone):
npm install
typings install
npm install -g concurrently
npm install -g live-server
An issue will be assigned to you via GitHub. Your workflow begins after assignment:
dev
branch with your initials and the issue number as the branch name (e.g. JD-5): git checkout -b JD-5
npm start
git add .
git status
git commit -m "#5 added styling"
dev
branch:
git pull origin dev
dev
branch will be incorporated into your local branch automatically.git add .
and then commit again: git commit -m "add message here"
git push origin JD-5
dev
branch.dev
branch and you can start on a new issue.Serve files with hot module replacement (live reload)
npm start
To build a production version of the app:
npm run-script build
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.
We use SemVer for versioning. For the versions available, see the tags on this repository.
Commit, Sync, and Merge Pull Request on any current project changes. The steps below require a clean git status.
Make sure you have the latest dependencies by running npm install
Update version number. Search for the current version number in the code, replace all instances of old version number with new version number.
Push the commit that contains the json files with bumped versions to your personal github repo
git add .
git commit -m "bump version"
Create pull request with version incremented (github.com)
Create new release on github.com
To push tags to remote origin: git push origin --tags
*Note that your alias for the remote origin may differ.
See also the list of contributors who participated in this project.
This project is licensed under the Creative Commons CC0 1.0 Universal License - see the LICENSE.md file for details
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