Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/kernix13/typescript-virtual-keyboard

TypeScript app for a virtual keyboard to assist people with reduced fine motor skills.
https://github.com/kernix13/typescript-virtual-keyboard

typescript virtual-keyboard

Last synced: about 1 month ago
JSON representation

TypeScript app for a virtual keyboard to assist people with reduced fine motor skills.

Awesome Lists containing this project

README

        

# Virtual Keyboard Assistant

![Virtiual Keyboard](./writer-assist-github-800.png)

A TypeScipt virtual keyboard project to assist people with reduced fine motor skills in composing letters and emails to friends, family, and work colleagues.

## Live Version

This page is currently deployed on Netlify. Try the [live version](https://cool-travesseiro-9b6101.netlify.app/) or learn more about the app on [my portfolio site](https://courageous-cuchufli-816711.netlify.app/).

## Setup

The only dependency is TypeScript:

```sh
# Initiate a Node.js project (creates package.json):
npm init -y
# Install Typescript as a dev dependency:
npm install typescript --save-dev
# Initialize TypeScript (creates tsconfig.json):
npx tsc --init
# Create dist and src folders:
mkdir dist src
# create main .ts file:
touch src/index.ts
# Create HTML file for deploy in dist folder:
touch dist/index.html
# Build and watch your files:
npx tsc -w
# Or just build your files:
npx tsc
```

Double check the values in `tsconfig.json` such as `outDir` which is set to `./dist`.

## Feedback and Bugs

Open a GitHub issue if you found any bugs or have feeback about the app.

## Contributing

If you would like to contribute to the project, then create a Pull Request with your suggested changes. Also, please read our [contributing guidelines](https://github.com/Kernix13/typescript-virtual-keyboard/blob/main/CONTRIBUTING.md) before creating your PR.

## Code of Conduct

Please read our [Code of Conduct](https://github.com/Kernix13/typescript-virtual-keyboard/blob/main/CODE_OF_CONDUCT.md) before interacting with our community.

## License

The content of this repository is bound by the [MIT license](https://github.com/Kernix13/typescript-virtual-keyboard/blob/main/LICENSE).

Copyright © 2022 Jim Kernicky.