npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

edk-route-verifier

v2.5.0

Published

Extreme Way of the Cross project route verifier

Downloads

12

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

qoobanqooban

Keywords

Readme

EDK Route Verifier

CircleCI jest Cypress.io tests npm

EDK Route Verifier is a tool which allows user to verify provided KML file with EDK route against predefined set of rules (eg. minimal length) and provide route characteristics (eg. length, elevations).

It is delivered in 3 different flavours: API server, CLI tool and UI version.

UI

CLI

Usage

Prerequisities

  • NodeJS >= v12.x (using ES modules)
  • Google Maps API Key (using the following APIs: Google Maps Elevation API, Google Maps Embed API, Google Maps JavaScript API)

Installation

npm install --global edk-route-verifier

Configuration

You need to create JSON configuration file containing at least Google Maps API key.

You can use config.json.template file as a base.

Start

Check out usage at in CLI usage documentation or just execute:

edk-route-verifier --help

To start verifier you will need configuration file created in previous step. To run verifier as API server execute:

edk-route-verifier server -c config.json

Flavours

EDK Route Verifier is delivered in 3 different flavours:

  1. API - starts HTTP server exposing verification endpoint
  2. CLI - allows user to verify EDK route from command line
  3. UI - allows user to verify EDK routes with web UI

Testing

Local

Tests are developed using Jest and Cypress frameworks. All test-related code is stored in test subdirectory.

To run all tests (UI, API, CLI + static code analysis):

npm run test

Continuous Integration

CircleCI web application is used as for CI management. See .circleci/config.yml file for details of the build and test job configuration.

You can create your own branch, push it to remote and CI will start automatically. That way you can test your code even if you don't have local environment configured (NodeJS, Google Maps API Key, etc.).

Deployment

edk-route-verifier is published in NPM registry.

Follow this step-by-step guide to publish new version:

  1. Create configuration file conf/config.json
  2. Checkout master branch
  3. Execute npm run publish:[prerelease|patch|minor|major]
  4. After successful execution, check CircleCI
  5. If everything went fine, then create release in GitHub releases