Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cosmicdna/touchscreen-stenography-keyboard

plover react reactjs reactthreefiber stenography

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/cosmicdna/touchscreen-stenography-keyboard
Owner: CosmicDNA
License: mit
Created: 2024-02-26T11:24:49.000Z (9 months ago)
Default Branch: main
Last Pushed: 2024-04-19T21:39:29.000Z (7 months ago)
Last Synced: 2024-09-30T02:32:17.181Z (about 2 months ago)
Topics: plover, react, reactjs, reactthreefiber, stenography
Language: JavaScript
Homepage: https://touch-stenography-keyboard.netlify.app/
Size: 11.4 MB
Stars: 3
Watchers: 0
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Touchscreen Stenography Keyboard

[![Netlify Status](https://api.netlify.com/api/v1/badges/2bf602f1-52ec-4611-8b73-bce4dd90a99b/deploy-status)](https://app.netlify.com/sites/touch-stenography-keyboard/deploys)

![GitHub License](https://img.shields.io/github/license/CosmicDNA/touchscreen-stenography-keyboard)

[![DeepScan grade](https://deepscan.io/api/teams/23301/projects/26581/branches/848067/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=23301&pid=26581&bid=848067)

## Repository

This code repository 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.

## 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](assets/20240413_151518.png)

*Plover way in Cornish*

> [!TIP]

> Install plover-enginer-server with the following command from within Plover's installation directory:

> ```shell

> ./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.

https://github.com/CosmicDNA/touchscreen-stenography-keyboard/assets/92752640/c5960847-21dc-412f-a4d8-af9af335dbce

*Usage example for typing*

## Development

![touchscreen-stenography-keyboard-build](https://github.com/CosmicDNA/touchscreen-stenography-keyboard/assets/92752640/1f1da328-26f4-4ca3-8055-f623a19b7edb)

*How to start the server in production mode*

### Running

In your terminal run:

```shell

yarn && yarn dev

```

### Building

```shell

yarn build

yarn global add serve

```

### Serving Production Build

```shell

NODENV=production && serve -s build

```

## Powered by

[![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)](https://react.dev/)

[![Netlify](https://img.shields.io/badge/Netlify-00C7B7?style=for-the-badge&logo=netlify&logoColor=white)](https://www.netlify.com/)