gbmhunter / ninjaterm Goto Github PK

NinjaTerm is now a PWA (Progressive Web App). Just visit https://ninjaterm.mbedded.ninja to open the app. Click the install button if you want to install in locally and be able to use it offline.

You can also access older versions of NinjaTerm at GitHub Releases.

Clone this repo. Then run npm install to install dependencies:

npm install

Start the app in the dev environment:

npm run start

Both unit tests and end-to-end tests can be run with:

npm run test

Unit tests are run with vitest, which has good integration with Vite.

To run just the unit tests, use the command:

npx vitest run

End-to-end (E2E) (a.k.a. integration tests) are performed using Playwright. The Playwright tests are located in the tests/ directory, and the Playwright config is at playwright.config.ts.

To run just the E2E tests from command line:

npx playwright test

The Playwright plug-in for VS Code is recommended if interacting with these tests, as it makes running and debugging of them easy!

Arduino sketches in arduino-serial allow you to program different applications onto an Arduino for testing the serial port with.

1. Update the version number to the appropriate number in package.json. Major version number change for big changes (e.g. framework change or compete overhaul of UI). Minor version change when additional features have been added. Patch version change for bug fixes and small changes to existing functionality.
2. Update the CHANGELOG (don't forget the links right at the bottom of the page).
3. Commit changes and push to develop.
4. Create pull request on GitHub merging develop into main.
5. Once the build on develop has been successfully run, merge the develop branch into main via the merge request.
6. Tag the branch on main with the version number, e.g. v4.1.0.
7. Create a release on GitHub pointing to the tag.
8. Enter the CHANGELOG contents into the release body text.
9. Checkout the develop branch and fast-forward it to the new commit on main.

Netlify is used to deploy and host the static NinjaTerm HTML/JS. Netlify automatically deploys when the main branch is updated. Netlify also creates preview deploys on pull requests (link will be automatically posted into the PR comments).

Create React App (CRA) with the typescript PWA template docs here was used as a starting point for development:

npx create-react-app my-app --template cra-template-pwa-typescript

NOTE: Since then, the app has been migrated from using `create-react-app`` (which uses the Webpack compiler) to using the Vite compiler.

The source code is under src/. The React-based user interfaces are in .tsx files, and the MobX "models" (you could kind of call them stores) are typically in .ts files. There is generally 1 model file per React view to store all the stateful information relating to that view.

NinjaTerm is a progressive web app (PWA). This means it can be "installed" by the user and can run offline. Most of this functionality is provided by "Vite PWA". The configuration for the PWA is defined in vite.config.ts.

Both recharts and chart.js was trialed for graphing data coming in on a serial port.

chart.js was chosen as it offered much better performance when the data update rate was fast. rechart could handle about 100 points, any more than that at the render time per new point started to take more than 50ms. chart.js can re-render 1000 points and stay under that limit.

FontCreator was used to create the special NinjaTerm font. It is based of Consolas. The FontCreator project file is at src/fonts/NinjaTerm.fcp and the generated font files are NinjaTerm-Regular.woff and NinjaTerm-Regular.woff2.

The PUA (Personal Use Area) is used to add custom glyphs to represent control characters and generic hex bytes. The following code point ranges are used:

• U+E000 - U+E07F: Contains control character glyphs were applicable. Add 0xE000 to a byte which contains a control character to get the equivalent glyph.
• U+E100 - U+E1FF: Contains a glyph for each byte from 0x00 to 0xFF containing the byte as a hex number. For example, U+E100 contains a glyph that says 00, and U+E1FF contains a glyph that says FF. Add 0xE100 to a normal byte to get the corresponding glyph.

In FontCreator, make sure the setting Tools->Options->Fonts->Exclude unused glyphs is unchecked, otherwise glyphs at code points like 0x0001 will not be generated.

• #DC3545 (red): Primary colour, used for logo.
• #E47F37 (orange): Secondary colour, used for buttons on homepage.

If you get the error:

Grid2.js:7 Uncaught TypeError: styled_default is not a function
    at Grid2.js:7:26

Comment out the line:

include: ['@mui/material/Tooltip', '@emotion/styled', '@mui/material/Unstable_Grid2'],

in vite.config.ts. This should fix it. You can then uncomment the line again. Toggling this seems to fix this bug, which after reading online might be due to Vite.

• Prettier ESLint: Provides formatting of .tsx files.
• Playwright: Provides useful add-ons for running and debugging the Playwright E2E tests.