NinjaTerm

A serial port terminal that's got your back.

Install

Required dependencies before install:

1. npm
2. yarn
3. git

Then just run:

git clone
yarn

Development

Start the app in the dev environment:

yarn start

Note: Icon in development will default to Electron icon even though NinjaTerm icon will be used when packaging for releases, see https://github.com/electron-react-boilerplate/electron-react-boilerplate/issues/1710#issuecomment-414199480.

Running Tests

yarn build # Only needed if app has not been built via other means yet
yarn test

Running Lint Checks

yarn lint

Running Typescript Checks

yarn tsc

Skip Husky Pre-commit Checks

Use the --no-verify flag as shown:

git commit --no-verify -m "Message goes here."

Packaging for Production

To package apps for the local platform:

yarn package

Packages are created in the release directory. Because the native module serialport is used, each package has to be built on it's respective platform.

Packaging is performed by the electron-builder library. The config for this is contained within the top-level package.json under "build".

Version number is contained within the "inner" package.json at src/package.json.

CICD

GitHib Actions are used for running automated tests and creating releases (which include built and packaged executables for all supported platforms).

Maintainers

• Geoffrey Hunter

History

Electron version based of the electron-react-boilerplate repo, at v1.4.0.

License

MIT © gbmhunter