mirror of https://github.com/keymanapp/keyman.git synced 2026-08-09 18:35:32 +00:00

History

Joshua A. Horton daf56bb7e8 fix(android): fixes CI build missing sentry-manager product		2022-10-24 10:58:25 +07:00
..
bulk_rendering	fix(web): bulk-renderer source links	2022-10-24 08:44:20 +07:00
samples	fix(web): ui module linking for sample/test pages	2022-10-24 10:16:06 +07:00
src	fix(android): fixes CI build missing sentry-manager product	2022-10-24 10:58:25 +07:00
testing	fix(web): ui module linking for sample/test pages	2022-10-24 10:16:06 +07:00
tools	fix(web): ui module linking for sample/test pages	2022-10-24 10:16:06 +07:00
unit_tests	fix(web): web ui-module test cases	2022-10-24 10:19:43 +07:00
.build-builder	chore(web): moves main web script to /web, adds .build-builder file as flag for CI	2022-10-18 13:59:19 +07:00
.gitattributes	Patches up the /samples pages.	2018-01-08 09:51:19 +07:00
.gitignore	chore(web): adjustments for PR review comments	2021-06-16 08:21:39 +07:00
build.sh	change(web): converts output-path script vars, links android-harness to build:samples	2022-10-24 08:49:24 +07:00
build_kill_browserstack.sh	change(web): src modularization, build dir reorg	2022-10-21 15:54:38 +07:00
history.md	chore: merge stable history	2020-04-29 06:33:31 +10:00
index.html	fix(web): recorder operational in new location	2020-05-01 08:06:12 +07:00
keyman.js.map	change(web): src modularization, build dir reorg	2022-10-21 15:54:38 +07:00
LICENSE	Move KeymanWeb project to web/	2017-05-26 11:00:34 +07:00
NOTICE	Move KeymanWeb project to web/	2017-05-26 11:00:34 +07:00
package.json	chore(web): updates karma dev-dependency	2022-09-22 09:13:20 +07:00
README.md	fix(web): updates testing-page links	2022-10-24 08:43:59 +07:00

README.md

Keyman Engine for Web

The Original Code is (C) SIL International

Prerequisites

See build configuration for details on how to configure your build environment.

The following folders contain the distribution for Keyman Engine for Web:

source                       Source code
source/resources/osk         OSK resources for inclusion in mobile app builds;
                             keymanweb-osk.ttf is maintained at https://github.com/silnrsi/font-keymanweb-osk
unit_tests                   Automated testing resources

build/web/release            Fully-compiled KeymanWeb modules for testing
build/embed/release          Fully-compiled KMEA/KMEI modules for inclusion in mobile app builds
build/web/debug            Fully-compiled but non-minified KeymanWeb modules
build/web/release          Fully-compiled KMEA/KMEI modules for inclusion in mobile app builds

samples                      Sample pages demonstrating ways to link with KeymanWeb
testing                      Test-case web-pages for various aspects of KeymanWeb functionality
unit_tests                   A Node-driven test suite for automated testing of KeymanWeb

Usage

Open index.html or samples/index.html in your browser. Be sure to compile Keyman Engine for Web before viewing the pages.

Refer to the samples for usage details.

To view pages using compiled Keyman Engine for Web,

cd to keyman/web/source
Run ./build.sh
- Use ./build.sh --help for the script's documentation.

Unit Testing

Before running unit tests on Keyman Engine for Web, first run ./build.sh according to the instructions above.

Once the build is complete, running npm test will run the unit testing suite on your local machine in-browser. Alternatively, see unit_tests/test.sh, which the former command executes.

Debugging Unit Tests

During development, to run a specific unit test, change the it to it.only. You can also run all tests under a specific group with describe.only.
From this directory, run ./unit_tests/test.sh -debug. Alternatively, from web/ or any web/ subdirectory,
```
npm run test -- -debug
```
The -- part tells npm to funnel anything to the script as the script's command-line parameters. As long as it's run from somewhere within the web/ folder's hierarchy, that line will always run from web/, as that's where package.json is.
When the browser halts, click the "Debug" button which opens a new debugging tab.
In the Dev console, you can set a breakpoint in your test and refresh the page to debug