Skip to content

Latest commit

 

History

History
100 lines (69 loc) · 3.33 KB

README.md

File metadata and controls

100 lines (69 loc) · 3.33 KB
Raw

WiM

WIM Styleguide & Frontend tools

A collection of tools, guides, and code examples for setting up and developig websites.

Tools:

  • QR Code Link Generator - with WIM or USGS logo in center
  • iFrame / Geonarrative Generator - Create web pages embedded between required Headers and Footers
  • Leaflet Marker Creator - design CSS leaflet markers
  • Animated Loaders - design and get code for USGS and WIM animated loaders
  • App Layouts - create the base layout for a new app
  • USWDS - info on adding USWDS to your project
  • CSS Variables - set up CSS variables
  • Dark Mode - setting up dark mode or other CSS themes
  • Meta Tags - common meta tags for a new project
  • Components - reusable components
  • Printing - information and code examples for creating printable sections
  • Colors - view and copy colors and shades
  • Logos - view and download WIM and USGS logos
  • Interface icons - Set up and use Font Awesome

Prerequisites

Vue CLI

npm install -g @vue/cli

Getting Started

Installing

npm install

Building and testing

Serve on localhost:8080

npm run serve

Bundle Analyzer will also be running at :8888

Build

npm run build

Other Commands

Run your tests

npm run test

Lints and fixes files

npm run lint

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

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.