ShipEngine Connect Local Dev UI

⚠ 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 provides a web interface for interacting with ShipEngine Connect apps on a local dev machine.

Note: You need to have the ShipEngine Connect local API up and running.

Development

npm start

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode. See the section about running tests for more information.

npm run build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes. Your app is ready to be deployed!

See the section about deployment for more information.

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.