typey-type
typey-type copied to clipboard
Typey Type for Stenographers is a free typing app designed specifically to help steno students practise and rapidly master stenography.
Typey Type for Stenographers
Typey Type is a free typing app designed for steno students to practise and master stenography.
Sponsor
You can support Di’s efforts on Patreon. A monthly donation helps Di build more lessons and features to help you fast-track your steno progress.
What's stenography?
The process of writing shorthand is called stenography. Using a stenotype machine or a fancy keyboard, you can write over 200 words per minute. Typically, steno is used for courtroom reporting, closed captioning, and real-time translation. As a means of entering text, it’s also an excellent ergonomic alternative to typing with a QWERTY keyboard.
Aim
The aim of Typey Type is to fast-track learning and mastering steno skills. Typey Type helps novice stenographers by giving them:
- immediate feedback on typing speed and accuracy
- progress updates, including progress on brief vocabulary
- a course to follow, including material to type
- links to more information
Typey Type concentrates on practical skills, such as physical drilling and memorisation of briefs.
What Typey Type is not
Typey Type is not a generic typing app. Plenty of typing apps already exist for regular text input without stenography.
Instead, Typey Type concentrates on teaching people how to type using stenography. That means it includes features like steno diagrams showing steno briefs as hints for how to write words and using steno-specific data, such as lessons for “single-stroke briefs”.
Typey Type avoids generic typing features, such as competing for speed and accuracy against other typists, which any typing app might do, such as Typeracer.
Development
Requirements
Install yarn. Note: the project is currently built with Node version 14.
Installation
This project includes a Git submodule for Typey Type data, which includes a Git submodule for steno dictionaries. If you want to clone this repository as well as its submodules, you can use the --recursive
parameter:
git clone --recursive https://github.com/didoesdigital/typey-type.git
Alternatively, if you've already cloned the repository without the --recursive
parameter, you can load its submodules using submodule update
:
git submodule update --init --recursive
Change directory into the cloned repository:
cd typey-type
Once you've cloned the repository and updated its submodules, yarn install packages from package.json
:
yarn install
Updates
When you pull the latest code, you may need to update submodules too:
git submodule update
Run the app in development mode
Run the Typey Type app:
yarn start
Open http://localhost:3000 to view it in the browser.
Offline
To use Typey Type offline, you can follow the steps in this README to install and start the app in development mode, and copy your progress words from the Progress page online to your local progress page http://localhost:3000/typey-type/progress before going offline.
Testing
Run the test runner during development:
yarn test
Storybook
Run Storybook to develop and test components in isolation:
yarn storybook
Create React App
For reference, Typey Type is bootstrapped with Create React App.
Contributing
See the CONTRIBUTING guidelines.
Code of Conduct
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
License
See LICENSE.
The metronome sound, “digi_plink”, comes from Dev_Tones by RCP Tones under a Creative Commons license (CC BY 3.0 US) and was adapted to include silence at the end for a slower metronome tempo.
Author
Typey Type was created by Di.