https://github.com/aabuhijleh/hid-headset-test
https://github.com/aabuhijleh/hid-headset-test
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/aabuhijleh/hid-headset-test
- Owner: aabuhijleh
- License: cc0-1.0
- Created: 2020-08-13T15:42:49.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-13T16:19:54.000Z (almost 5 years ago)
- Last Synced: 2025-02-05T05:34:21.643Z (4 months ago)
- Language: TypeScript
- Size: 1.28 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# HID Headset Test
## Prerequisites
- Node.js v12 or higher should be installed on your machine
- [node-gyp](https://github.com/nodejs/node-gyp#installation)'s prerequisites need to be installed
## How to use?
```sh
# install dependencies
$ npm install
# compile typescript files
$ npm run compile
# watch typescript files for changes (auto compilation)
$ npm run watch
# run the app
$ npm start
# create distributable packages for specific platforms
$ npm run dist-linux
$ npm run dist-mac
$ npm run dist-windows
```
## Troubleshooting
If you get "Module did not register" or "Compiled against a different Node.js version" errors after starting the app, this means a native module dependency was not built correctly. Let electron-builder rebuild it for you by running a `npm run dist-${platform}` command.
## Directory Structure
.
├── electron-builder.json (electron-builder configuration)
├── .gitignore
├── LICENSE.md
├── package.json
├── package-lock.json
├── README.md
├── src (typescript files go here)
│ ├── main.ts
│ ├── preload.ts
│ └── renderer.ts
├── tsconfig.json (typescript compiler options)
├── tslint.json (tslint configuration)
└── views (html, css files go here)
└── index.html
## Resources
- [Electron docs](https://www.electronjs.org/docs)
- [electron-builder docs](https://www.electron.build)
- [Typescript docs](https://www.typescriptlang.org/docs)
- [Tslint docs](https://palantir.github.io/tslint/usage/configuration)