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

@shipengine/connect-local-dev-api

v2.2.1

Published

The ShipEngine Integration Platform local development API

Downloads

17

Readme

ShipEngine Connect

ShipEngine Connect Local Dev API

Cross-Platform Compatibility Build Status

Dependencies npm License

⚠ WARNING: This is an internal package

Using this package directly is discouraged and unsupported. Instead, you should install @shipengine/connect which uses this package under the hood. See our documentation for more information.

This package makes ShipEngine Connect apps callable via an API. It can be used as a standalone tool, or via the ShipEngine Connect CLI.

Usage

$ npm install @shipengine/connect-local-dev-api
"use strict";

const server = require("@shipengine/connect-local-dev-api")
  .default;

const pathToApp = process.argv[2];
const port = process.argv[3];

server(port, pathToApp);

Development

The development server will start on localhost:3000 by default. It automatically detects file changes with nodemon, and transpiles TypeScript on the fly using ts-node.

Note: Make sure to edit nodemon.json so that the exec command points to the absolute path of the Connect App on your system.

$ npm run start:dev

Testing

Test are written in TypeScript, and use ts-node to handle transpiling.

$ npm test

Releasing

To release a new version, use the command below.

npm run release

This will do the following:

  • Display any outdated dependencies and prompt you to update them
  • Run a security vulnerability audit
  • Do a clean re-build
  • Run all tests
  • Run linter checks
  • Prompt you for the version number to bump to
  • Tag, commit, and push to GitHub

Once the commit is merged to the master branch, the CI/CD script will publish it to NPM.