{"id":18810979,"url":"https://github.com/shipengine/connect-local-dev-api","last_synced_at":"2026-05-05T20:40:25.658Z","repository":{"id":56598046,"uuid":"285877587","full_name":"ShipEngine/connect-local-dev-api","owner":"ShipEngine","description":"API server to support local development of ShipEngine Connect apps","archived":false,"fork":false,"pushed_at":"2021-01-15T20:57:50.000Z","size":537,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-01-31T11:11:07.882Z","etag":null,"topics":["javascript","nodejs","typescript"],"latest_commit_sha":null,"homepage":"https://connect.shipengine.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ShipEngine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-07T16:45:02.000Z","updated_at":"2021-02-16T22:26:25.000Z","dependencies_parsed_at":"2022-08-15T21:40:32.040Z","dependency_job_id":null,"html_url":"https://github.com/ShipEngine/connect-local-dev-api","commit_stats":null,"previous_names":[],"tags_count":48,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShipEngine%2Fconnect-local-dev-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShipEngine%2Fconnect-local-dev-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShipEngine%2Fconnect-local-dev-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShipEngine%2Fconnect-local-dev-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ShipEngine","download_url":"https://codeload.github.com/ShipEngine/connect-local-dev-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239748254,"owners_count":19690232,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","nodejs","typescript"],"created_at":"2024-11-07T23:23:39.493Z","updated_at":"2026-01-11T02:30:15.203Z","avatar_url":"https://github.com/ShipEngine.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![ShipEngine Connect](https://connect.shipengine.com/img/logos/shipengine-connect-logo.png)](https://connect.shipengine.com)\n\nShipEngine Connect Local Dev API\n=======================================\n\n[![Cross-Platform Compatibility](https://shipengine.github.io/img/badges/os-badges.svg)](https://github.com/ShipEngine/connect-local-dev-api/actions)\n[![Build Status](https://github.com/ShipEngine/connect-local-dev-api/workflows/CI-CD/badge.svg)](https://github.com/ShipEngine/connect-local-dev-api/actions)\n\n[![Dependencies](https://david-dm.org/ShipEngine/connect-local-dev-api.svg)](https://david-dm.org/ShipEngine/connect-local-dev-api)\n[![npm](https://img.shields.io/npm/v/@shipengine/connect-local-dev-api.svg)](https://www.npmjs.com/package/@shipengine/connect-local-dev-api)\n[![License](https://img.shields.io/npm/l/@shipengine/connect-local-dev-api.svg)](LICENSE)\n\n\n\u003cp\u003e\u003cbr\u003e\u003c/p\u003e\n\n\u003e ### ⚠ WARNING: This is an internal package\n\u003e Using this package directly is discouraged and unsupported. Instead, you should install\n\u003e [**@shipengine/connect**](https://www.npmjs.com/package/@shipengine/connect) which uses this package under the hood.\n\u003e See [our documentation](https://connect.shipengine.com/docs/cli) for more information.\n\n\u003cp\u003e\u003cbr\u003e\u003c/p\u003e\n\n\nThis package makes ShipEngine Connect apps callable via an API. It can be used as a standalone tool, or via the [ShipEngine Connect CLI](https://www.npmjs.com/package/@shipengine/connect-local-dev-api).\n\n\nUsage\n------------------------\n\n```sh-session\n$ npm install @shipengine/connect-local-dev-api\n```\n\n```javascript\n\"use strict\";\n\nconst server = require(\"@shipengine/connect-local-dev-api\")\n  .default;\n\nconst pathToApp = process.argv[2];\nconst port = process.argv[3];\n\nserver(port, pathToApp);\n```\n\n\nDevelopment\n---------------------\nThe development server will start on [localhost:3000](http://localhost:3000) by default. It automatically detects file changes with [nodemon](https://www.npmjs.com/package/nodemon), and transpiles TypeScript on the fly using [ts-node](https://www.npmjs.com/package/ts-node).\n\n*Note*: Make sure to edit `nodemon.json` so that the `exec` command points to the absolute path of the Connect App on your system.\n\n```sh-session\n$ npm run start:dev\n```\n\n\nTesting\n---------------------\nTest are written in TypeScript, and use [ts-node](https://www.npmjs.com/package/ts-node) to handle transpiling.\n\n```sh-session\n$ npm test\n```\n\n\nReleasing\n-----------------------\nTo release a new version, use the command below.\n\n```sh-session\nnpm run release\n```\n\nThis will do the following:\n\n- Display any outdated dependencies and prompt you to update them\n- Run a security vulnerability audit\n- Do a clean re-build\n- Run all tests\n- Run linter checks\n- Prompt you for the version number to bump to\n- Tag, commit, and push to GitHub\n\nOnce the commit is merged to the `master` branch, the [CI/CD script](.github/workflows/CI-CD.yaml) will publish it to NPM.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshipengine%2Fconnect-local-dev-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshipengine%2Fconnect-local-dev-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshipengine%2Fconnect-local-dev-api/lists"}