/speakeasy

Thing I'm working on for keyboards

Primary LanguageJavaScriptMIT LicenseMIT

MajorKey

A Cross-platform desktop app to remap keyboards

Known Issues

Steps to build

change script abirebuild in package.json target to your version of electron and abi to your node abi version

npm i 
npm install --global --production windows-build-tools
npm run abirebuild
./node_modules/.bin/electron-rebuild

Run

Start the app in the dev environment. This starts the renderer process in hot-module-replacement mode and starts a server that sends hot updates to the renderer process:

npm run dev

Run these two commands simultaneously in different console tabs:

npm run start-renderer-dev
npm run start-main-dev

Packaging

To package apps for the local platform:

npm run package

To package apps for all platforms:

First, refer to Multi Platform Build for dependencies.

Then,

npm run package-all

To package apps with options:

npm run package -- --[option]

Further commands

To run the application without packaging run

npm run build
npm start

To run End-to-End Test

npm run build
npm run test-e2e

Options

See electron-builder CLI Usage

How to add modules to the project

You will need to add other modules to this boilerplate, depending on the requirements of your project. For example, you may want to add node-postgres to communicate with PostgreSQL database, or material-ui to reuse react UI components.

Please read the following section before installing any dependencies

Module Structure

This boilerplate uses a two package.json structure. This means, you will have two package.json files.

  1. ./package.json in the root of your project
  2. ./app/package.json inside app folder

Which package.json file to use

Rule of thumb is: all modules go into ./package.json except native modules. Native modules go into ./app/package.json.

  1. If the module is native to a platform (like node-postgres) or otherwise should be included with the published package (i.e. bcrypt, openbci), it should be listed under dependencies in ./app/package.json.
  2. If a module is imported by another module, include it in dependencies in ./package.json. See this ESLint rule. Examples of such modules are material-ui, redux-form, and moment.
  3. Otherwise, modules used for building, testing and debugging should be included in devDependencies in ./package.json.

Further Readings

See the wiki page, Module Structure — Two package.json Structure to understand what is native module, the rationale behind two package.json structure and more.

For an example app that uses this boilerplate and packages native dependencies, see erb-sqlite-example.

Static Type Checking

This project comes with Flow support out of the box! You can annotate your code with types, get Flow errors as ESLint errors, and get type errors during runtime during development. Types are completely optional.