Touchscreen Stenography Keyboard

Repository

This code repository is hosted at https://github.com/CosmicDNA/touchscreen-stenography-keyboard

Purpose of The Project

The aim of this project is to render with React Three Fiber a usefull stenography touchscreen keyboard. So that users can safely send keystrokes to whichever computer running Plover they want.

Deployed Application

The application was deployed to Netlify and is available at:

https://touch-stenography-keyboard.netlify.app/

Usage Example

Plover connection configuration

Plover way in Cornish

Tip

The recommended way to install the plover-websocket-server plugin is through Plover's Plugin Manager. Open Plover, go to Tools, click on Plugins Manager, select plover-websocket-server and click on Install/Update button. Finally click on Restart button.

Alternatively, you can still install it with plover_console with following command line from within Plover's installation directory:

./plover_console -s plover_plugins install git+https://github.com/CosmicDNA/plover_websocket_server.git

The following image shows the default configuration for the application. If you have created a custom plover_engine_server_config.json, make sure it is matching the configuration within this app.

App configuration window

In the following video, it is being typed upon:

This is an example of machine shorthand from a steno keyboard with paper.

v4.mp4

Usage example for typing

Development

How to start the server in production mode

Running

In your terminal run:

yarn && yarn dev

Building

yarn build
yarn global add serve

Serving Production Build

NODENV=production && serve -s build

Additional Configuration

To use the plugin with the deployed Netlify frontend and follow the plover-websocket-server guidelines, ensure your plover_websocket_server_config.json file includes the Netlify URL in the remotes pattern section. You can use for example a remotes pattern that includes both localhost:8086 and touch-stenography-keyboard.netlify.app:

{
  "remotes": [
    {
      "pattern": "^https?:\/\/(localhost?(:[0-9]*)?|touch-stenography-keyboard.netlify.app)$"
    }
  ]
}

Powered by