https://github.com/shipengine/connect-local-dev-ui
Web UI to support local development of ShipEngine Connect apps
https://github.com/shipengine/connect-local-dev-ui
javascript nodejs react typescript
Last synced: 2 months ago
JSON representation
Web UI to support local development of ShipEngine Connect apps
- Host: GitHub
- URL: https://github.com/shipengine/connect-local-dev-ui
- Owner: ShipEngine
- Created: 2020-08-03T18:11:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-18T17:02:34.000Z (about 5 years ago)
- Last Synced: 2025-01-30T15:05:51.399Z (about 1 year ago)
- Topics: javascript, nodejs, react, typescript
- Language: TypeScript
- Homepage: https://connect.shipengine.com
- Size: 1.59 MB
- Stars: 1
- Watchers: 14
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://connect.shipengine.com)
ShipEngine Connect Local Dev UI
=======================================
[](https://github.com/ShipEngine/connect-local-dev-ui/actions)
[](https://github.com/ShipEngine/connect-local-dev-ui/actions)
[](https://david-dm.org/ShipEngine/connect-local-dev-ui)
[](https://www.npmjs.com/package/@shipengine/connect-local-dev-ui)
[](LICENSE)
> ### ⚠ WARNING: This is an internal package
> Using this package directly is discouraged and unsupported. Instead, you should install
> [**@shipengine/connect**](https://www.npmjs.com/package/@shipengine/connect) which uses this package under the hood.
> See [our documentation](https://connect.shipengine.com/docs/cli) for more information.
This package provides a web interface for interacting with [ShipEngine Connect](https://connect.shipengine.com) apps on a local dev machine.
*Note: You need to have the ShipEngine Connect [local API](https://github.com/ShipEngine/connect-local-dev-api) up and running.*
Development
---------------------
### `npm start`
Runs the app in the development mode.
Open [http://localhost:3000](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](https://facebook.github.io/create-react-app/docs/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](https://facebook.github.io/create-react-app/docs/deployment) for more information.
Releasing
-----------------------
To release a new version, use the command below.
```sh-session
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](.github/workflows/CI-CD.yaml) will publish it to NPM.