erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 08:25:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10
spiegel-keyman/web
History
jahorton 4dc09ce9b9 refactor(web): partial font-size logic rework
2021-07-26 15:21:01 +07:00
..
bulk_rendering fix(web): bulk rendering docs 2021-01-22 16:07:45 +11:00
samples chore(web): tweaks sample pages to use init's promise for keyboard loading 2021-01-14 09:23:11 +07:00
source refactor(web): partial font-size logic rework 2021-07-26 15:21:01 +07:00
testing chore(web): test page tweaks (fewer keyboards on non-toolbar UI) 2021-07-21 15:46:00 +07:00
tools fix(web): patches up KMW recorder 2021-06-14 15:32:40 +07:00
unit_tests fix(common): build script help param 2021-05-28 09:50:40 +10: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
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
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-lock.json auto: increment master version to 15.0.88 2021-07-22 14:01:23 -04:00
package.json auto: increment master version to 15.0.88 2021-07-22 14:01:23 -04:00
README.md docs: start consolidation of build config docs 2021-06-21 21:12:27 +10:00

README.md

Keyman 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 KeymanWeb:

source                      Source code
sources/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

intermediate    	Intermediate compiled code; TypeScript source is compiled here before it is minified.
release/web			Fully-compiled KeymanWeb modules for testing
release/embedded	Fully-compiled KMEA/KMEI modules for inclusion in mobile app builds
release/unminified/web       Fully-compiled but non-minified KeymanWeb modules
release/unminified/embedded  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 KeymanWeb before viewing the pages.

Refer to the samples for usage details.

To view pages using compiled KeymanWeb,

  1. cd to keyman/web/source
  2. Run ./build.sh

build.sh options:

  • -ui
    • to compile desktop user interface modules to output folder
  • -test
    • to compile for testing without copying resources or updating the saved version number.
  • -embed
    • to compile only the KMEA/KMEI embedded engine.
  • -web
    • to compile only the KeymanWeb engine.
  • -debug_embedded
    • to compile a readable version of the embedded KMEA/KMEI code
  • -no_minify
    • to disable the minified '/release/web' and '/release/embedded' build sections.
    • the '/release/unminified/web' and '/release/unminified/embedded' folders will still be built.
  • -clean
    • to erase pre-existing build products before the build.

If more than one target is specified, the last one will take precedence.

Unit Testing

Before running unit tests on KeymanWeb, 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.