mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 08:25:32 +00:00

History

Marc Durdin 4598f13ba8 chore(common): automatically apply _builder_check_color		2023-02-09 12:12:18 +07:00
..
src	chore(common): automatically apply _builder_check_color	2023-02-09 12:12:18 +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	change(web): unit_tests -> src/test/auto	2022-10-24 11:55:40 +07:00
build.sh	chore(common): automatically apply _builder_check_color	2023-02-09 12:12:18 +07:00
ci.sh	chore(web): even more requested changes	2023-02-01 14:05:01 +07:00
history.md	chore: merge stable history	2020-04-29 06:33:31 +10:00
index.html	chore(web): web index page cleanups	2022-11-29 09:47:32 +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	change(web): moves web test script to base web/ folder	2022-10-24 11:49:01 +07:00
README.md	chore(web): Apply suggestions from code review	2022-12-01 08:18:47 +07:00
test.sh	chore(common): automatically apply _builder_check_color	2023-02-09 12:12:18 +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 release
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/embed/debug          Fully-compiled but non-minified KMEA/KMEI modules

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